Improve collapsible, add repo to repotoc

Use content to generate the unique ID for the collapsible.
Add precision-converters-firmware to the repotoc.
Check if conf repository value is set before using it as a key.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>

Author: gastmaier

adi_doctools/__init__.py

@@ -9,7 +9,7 @@
 from .role import setup as role_setup
 from .lut import get_lut
 
-__version__ = "0.3.22"
+__version__ = "0.3.23"
 
 logger = logging.getLogger(__name__)
 

adi_doctools/directive/common.py

@@ -212,7 +212,8 @@ def run(self):
 
         node = node_div()
 
-        content, _ = self.collapsible(node, self.arguments[0].strip())
+        _id = sha1("".join(self.content).encode('utf-8')).hexdigest()
+        content, _ = self.collapsible(node, (_id, self.arguments[0].strip()))
         self.state.nested_parse(self.content, self.content_offset, content)
 
         return [node]

adi_doctools/lut.py

@@ -7,7 +7,6 @@
         'name': 'System Level',
         'branch': 'main',
         'release_format': 'const:latest',
-        'default_branch': 'main',
         'visibility': 'public',
         'topic': {
             'eval': 'Evaluation Boards',
@@ -24,31 +23,34 @@
         'name': 'HDL',
         'branch': 'main',
         'release_format': 'halves',
-        'default_branch': 'main',
         'visibility': 'public'
     },
     'no-OS': {
         'doc_folder': 'doc/sphinx/source',
         'name': 'no-OS',
         'branch': 'main',
         'release_format': 'const:latest_commit',
-        'default_branch': 'main',
         'visibility': 'public'
     },
     'pyadi-iio': {
         'doc_folder': 'doc',
         'name': 'pyadi-iio',
         'branch': 'main',
         'release_format': 'semantic',
-        'default_branch': 'main',
+        'visibility': 'public'
+    },
+    'precision-converters-firmware': {
+        'doc_folder': 'doc/sphinx',
+        'name': 'Precision Converters Firmware',
+        'branch': 'main',
+        'release_format': 'const:latest',
         'visibility': 'public'
     },
     'doctools': {
         'doc_folder': 'docs',
         'name': 'Doctools',
         'branch': 'main',
         'release_format': 'semantic',
-        'default_branch': 'main',
         'visibility': 'public-hidden'
     },
 }

adi_doctools/role/common.py

@@ -59,7 +59,7 @@ def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
 def datasheet():
     def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
         # DEPRECATED
-        logger.info("The datasheet role has been deprecated, use the adi role"
+        logger.info("The datasheet role has been deprecated, use the adi role "
                     "instead.")
         return [], []
 

adi_doctools/role/interref.py

@@ -587,15 +587,15 @@ def normalize_interref_mapping(app: Sphinx, config: Config) -> None:
                         f = open(path.join(app.srcdir, latest_txt), 'rb')  # NoQA: SIM115
                     release = f.readline().decode()
                     if release == "":
-                        logger.info(f"{repo} latest.txt is empty, setting release to \"{app.lut[repo]['default_branch']}\".")
-                        release = app.lut[repo]['default_branch']
+                        logger.info(f"{repo} latest.txt is empty, setting release to \"{app.lut[repo]['branch']}\".")
+                        release = app.lut[repo]['branch']
                 except Exception as err:
                     logger.warning(__('%r not fetchable due to %s: %s; setting release to \"%s\"'),
-                              latest_txt, err.__class__, str(err), app.lut[repo]['default_branch'])
-                    release = app.lut[repo]['default_branch']
+                              latest_txt, err.__class__, str(err), app.lut[repo]['branch'])
+                    release = app.lut[repo]['branch']
 
             else:
-                release = app.lut[repo]['default_branch']
+                release = app.lut[repo]['branch']
             uri = interref_uri + f"{repo}/{release}"
         else:
             uri = interref_uri + repo

adi_doctools/theme/__init__.py

@@ -11,7 +11,7 @@
 
 
 def theme_config_setup(app):
-    app.add_config_value('repository', '', 'env')
+    app.add_config_value('repository', None, 'env')
     app.add_config_value('monolithic', False, 'env')
     app.add_config_value('doctools_export_metadata', False, 'env')
 
@@ -75,7 +75,7 @@ def repotoc_tree(content_root, conf_vars, pagename):
     for item in repotoc:
         href = f"{content_root}{depth}{item}/{home}"
         attrib = {}
-        if item.startswith(repo):
+        if repo is not None and item.startswith(repo):
             if '/' in item:
                 sub = item[item.find('/')+1:]
                 href = f"{content_root}{sub}/{home}"
@@ -186,7 +186,8 @@ def iterate(elem):
                 iterate(li)
             lvl.pop()
 
-    if "topic" in app.lut[app.env.config.repository]:
+    repo = app.env.config.repository
+    if repo in app.lut and "topic" in app.lut[repo]:
         conf_vars_ = (get_topic(pagename), *conf_vars[1:])
         filter_tree(root, conf_vars_, pagename)
 

adi_doctools/theme/cosmic/style/collapsible.scss

@@ -28,6 +28,10 @@
     border-radius: .25em;
     margin-bottom: .5em;
 
+    .collapsible {
+        margin: .25em;
+    }
+
     label {
         width: 100%;
         padding: 0.75em 1em 0.75em .75em;

adi_doctools/theme/cosmic/style/header.scss

@@ -53,11 +53,18 @@ header {
     }
 
     .repotoc-tree {
-        padding-left: calc(40vw - 13em - 1em);
+        padding-left: calc(40vw - 15em);
         border-bottom: $border-panel;
         background: var(--bg-color1);
         height: 2.5em;
 
+        root {
+            padding-left: 1em;
+            display: block;
+            white-space: nowrap;
+            overflow-x: auto;
+        }
+
         a {
             cursor: pointer;
             display: inline-block;