search: bring new module to search across all tracked repositories

Extra also now works on local and offline contexts.

Signed-off-by: Jorge Marques <[email protected]>

Author: gastmaier

adi_doctools/lut.py

@@ -26,6 +26,7 @@ class Repo(TypedDict):
 class LUT(TypedDict):
     remote_ssh: str
     remote_https: str
+    remote_doc: str
     source_hostname: str
     repos: Dict[str, Repo]
     banner: Banner
@@ -151,6 +152,7 @@ def get_lut():
     # TODO dynamic lut fetch
     return LUT(remote_ssh=remote_ssh,
                remote_https=remote_https,
+               remote_doc=remote_doc,
                source_hostname=source_hostname,
                repos=repos,
                banner=banner,

adi_doctools/theme/__init__.py

@@ -25,6 +25,7 @@ def theme_config_setup(app):
     app.add_config_value('target_depth', None, 'env', [str])
 
     app.connect("config-inited", config_inited)
+    app.connect("builder-inited", builder_inited)
     app.connect("build-finished", build_finished)
 
 
@@ -52,6 +53,27 @@ def config_inited(app, config):
     if config.target_depth is not None or getenv("ADOC_TARGET_DEPTH", default=None) is not None:
         logger.info(f"ADOC_TARGET_DEPTH is deprecated and has no effect.")
 
+def builder_inited(app):
+    """
+    Remove Sphinx's default provided scripts
+    """
+    if app.env.config.html_theme not in names:
+        return
+
+    removal = [
+        "_static/documentation_options.js",
+        "_static/doctools.js",
+        "_static/sphinx_highlight.js"
+    ]
+    to_remove = []
+    if app.builder.format == 'html':
+        for js in app.builder._js_files:
+            if js.filename in removal:
+                to_remove.append(js)
+    for js_ in to_remove:
+        app.builder._js_files.remove(js_)
+
+
 def build_finished(app, exc):
     if app.builder.format == 'html' and not exc:
         if app.env.config.core_repo:
@@ -90,6 +112,7 @@ def build_finished(app, exc):
                     copy_asset_file(path.join(src_uri, m),
                                     path.join(build_uri, m))
 
+            metadata['remote_doc'] = app.lut['remote_doc']
             metadata['source_hostname'] = app.lut['source_hostname']
 
             file = path.join(app.builder.outdir, 'metadata.json')

adi_doctools/theme/cosmic/layout.html

@@ -41,8 +41,7 @@
   <div class="search-area">
     <form action="" method="get">
       <input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" role="search" placeholder="Search"/>
-      <button value="{{ _('search') }}" class="icon"></button>
-      <span id="search-progress"></span>
+      <button class="icon"></button>
     </form>
   </div>
   {% endblock %}
@@ -128,8 +127,6 @@
     {%- endblock %}
   </div>
 
-  <div id="vertical-border"></div>
-
   <label id="cancel-area-show-toc" for="input-show-toc"></label>
   <label id="cancel-area-show-localtoc" for="input-show-localtoc"></label>
 

adi_doctools/theme/cosmic/scripts/extra.js

@@ -1,11 +1,13 @@
 import { VersionDropdown } from './version_dropdown.js'
 import { Links } from './links.js'
 import { PageActions } from './page_actions.js'
+import { Search } from './search.js'
 
 export default function Extra (){
    new VersionDropdown(app)
    new Links(app)
    new PageActions(app)
+   new Search(app)
 }
 
 Extra()

adi_doctools/theme/cosmic/scripts/fetch.js

@@ -18,19 +18,13 @@ export class Fetch {
    * that contain the most up-to-date metadata
    */
   init () {
-    if (this.parent.state.offline === true) {
-      console.log("fetch: dynamic features are not available in offline mode")
-      return
-    } else if (this.parent.state.sub_hosted === false) {
-      console.log("fetch: dynamic features are not available for single repository doc")
-      return
-    }
-
+    let urls = [
+      'https://analogdevicesinc.github.io/doctools/metadata.json'
+    ]
+    if (this.parent.state.offline === false)
+      urls.unshift('/metadata.json', '/doctools/metadata.json')
     Toolbox.cache_check(this.parent.state,
-                        [
-                          '/doctools/metadata.json',
-                          'https://analogdevicesinc.github.io/doctools/metadata.json'
-                        ], 24, (obj) => {this.init_metadata(obj)})
+                        urls, 24, (obj) => {this.init_metadata(obj)})
   }
   /**
    * Attach metadata to this and call to inject extra modules.
@@ -54,13 +48,18 @@ export class Fetch {
 
     if (url.startsWith("https://") || url.startsWith("http://"))
       url = new URL(url).origin
+    else if (this.parent.state.offline === true)
+      url = `${this.parent.state.metadata.remote_doc}/doctools`
     else
       url = ""
 
+    let url_ = this.parent.state.sub_hosted === false ?
+       `${url}/_static/` : `${url}/doctools/_static/`
+
     if ('javascript' in obj) {
       obj['javascript'].forEach((elem) => {
         let script = new DOM('script', {
-          'src': `${url}/doctools/_static/${elem}`
+          'src': `${url_}${elem}`
         });
         this.$.head.append(script)
       })
@@ -70,7 +69,7 @@ export class Fetch {
         let style = new DOM('link', {
           'rel': 'stylesheet',
           'type': 'text/css',
-          'href': `${url}/doctools/_static/${elem}`
+          'href': `${url_}${elem}`
         });
         this.$.head.append(style)
       })

adi_doctools/theme/cosmic/scripts/links.js

@@ -32,6 +32,8 @@ export class Links {
   update_repotoc (obj) {
     let $ = this.$
 
+    let prefix = this.parent.state.sub_hosted === true ?
+                 '/' : this.parent.state.metadata.remote_doc
     let home = "index.html"
     let linksOverlay = [],
         linksSidebar = []
@@ -41,7 +43,7 @@ export class Links {
 
       let base = key == this.parent.state.repository ?
                  this.parent.state.content_root :
-                 `/${key}/`
+                 `${prefix}${key}/`
       linksSidebar.push(new DOM('a', {
         'href': `${base}${home}`,
         'className': this.parent.state.repository === key ? 'current' : '',

adi_doctools/theme/cosmic/scripts/navigation.js

@@ -25,16 +25,6 @@ export class Navigation {
     if (this.parent.state.theme !== this.os_theme())
       $.body.classList.add(this.parent.state.theme)
 
-	  $.searchButton = new DOM('button', {
-      id:'search',
-      className:'icon',
-      title:'Search (/)'
-    }).onclick(this, () => {
-      DOM.switchState($.searchArea)
-      DOM.switchState($.searchAreaBg)
-      $.searchInput.focus()
-      $.searchInput.$.select()
-    })
 	  $.changeTheme = new DOM('button', {
       className: this.parent.state.theme === 'dark' ? 'icon on' : 'icon',
       id:'theme',
@@ -50,22 +40,10 @@ export class Navigation {
       }
     })
 
-    $.searchAreaBg = new DOM('div', {
-      className:'search-area-bg'
-    }).onclick(this, () => {
-      DOM.switchState($.searchArea)
-      DOM.switchState($.searchAreaBg)
-    })
-    $.searchArea = new DOM(DOM.get('.search-area'))
-    $.searchForm = new DOM(DOM.get('form', $.searchArea))
-    $.searchInput = new DOM(DOM.get('input', $.searchForm))
-    $.searchForm.$['action'] = DOM.get('link[rel="search"]').href
-    $.body.append([$.searchAreaBg])
-
     $.preserve_scroll = {}
     $.preserve_scroll['sphinxsidebarwrapper'] = new DOM(DOM.get('.sphinxsidebarwrapper'))
 
-    $.rightHeader = new DOM(DOM.get('header #right span.reverse')).append([$.changeTheme, $.searchButton])
+    $.rightHeader = new DOM(DOM.get('header #right span.reverse')).append([$.changeTheme])
 
     $.relatedNext = DOM.get('.related .next')
     $.relatedPrev = DOM.get('.related .prev')
@@ -159,21 +137,6 @@ export class Navigation {
       }
     }
   }
-  /* Search shortcut */
-  search (e) {
-    if ((e.code === 'IntlRo' || e.code === 'Slash')
-        && !this.$.searchArea.classList.contains('on')) {
-      DOM.switchState(this.$.searchArea)
-      DOM.switchState(this.$.searchAreaBg)
-      this.$.searchInput.focus()
-      this.$.searchInput.$.select()
-    } else if (e.code === 'Escape') {
-      if (this.$.searchArea.classList.contains('on')) {
-        DOM.switchState(this.$.searchArea)
-        DOM.switchState(this.$.searchAreaBg)
-      }
-    }
-  }
   /* Related shortcut */
   related (e) {
     if (!e.altKey || !e.shiftKey)
@@ -200,7 +163,9 @@ export class Navigation {
       case 'IntlRo':
       case 'Slash':
       case 'Escape':
-        this.search(e)
+      case 'KeyK':
+        if (typeof this.parent.search !== "undefined")
+          this.parent.search.search(e)
         break
     }
   }
@@ -212,7 +177,16 @@ export class Navigation {
       case 'ArrowRight':
       case 'KeyA':
       case 'KeyD':
-        e.preventDefault()
+        if (e.altKey && e.shiftKey)
+          e.preventDefault()
+        return
+      case 'IntlRo':
+      case 'Slash':
+        return
+      case 'KeyK':
+        if (e.ctrlKey && e.altKey)
+          e.preventDefault()
+        return
     }
   }