crate-docs-theme 0.41.1.dev2__tar.gz → 0.43.0__tar.gz

{crate_docs_theme-0.41.1.dev2/src/crate_docs_theme.egg-info → crate_docs_theme-0.43.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crate-docs-theme
-Version: 0.41.1.dev2
+Version: 0.43.0
 Summary: CrateDB Documentation Theme
 Home-page: https://github.com/crate/crate-docs-theme
 Author: Crate.IO GmbH
@@ -17,25 +17,24 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Documentation
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: furo==2025.7.19
+Requires-Dist: furo==2025.9.25
 Requires-Dist: jinja2<4,>=3
 Requires-Dist: jupysql<0.12
 Requires-Dist: myst-nb<1.4
 Requires-Dist: myst-parser[linkify]<5
-Requires-Dist: oembedpy<0.9,>=0.8.1
 Requires-Dist: snowballstemmer<4
 Requires-Dist: sphinx<9,>=7.1
 Requires-Dist: sphinx-basic-ng==1.0.0b2
 Requires-Dist: sphinx-copybutton<1,>=0.3.1
-Requires-Dist: sphinx-design-elements==0.4.0
+Requires-Dist: sphinx-design-elements==0.4.1
 Requires-Dist: sphinx-inline-tabs
-Requires-Dist: sphinx-sitemap<2.8.0
-Requires-Dist: sphinx-subfigure<1
+Requires-Dist: sphinx-sitemap<2.10.0
 Requires-Dist: sphinx-togglebutton<1
 Requires-Dist: sphinxext.opengraph<1,>=0.4
 Requires-Dist: sphinxcontrib-mermaid<2
@@ -110,7 +109,7 @@ The documentation is composed of multiple separate documentation
 projects, interlinked via the CrateDB Documentation Theme.
 
 To update the root of the TOC sidebar for the entire documentation, update the
-`sidebartoc.html`` file.
+`sidebartoc.py`_ file.
 
 To use the theme, add this line to your Sphinx ``conf.py`` file::
 
@@ -136,7 +135,7 @@ Looking for more help?
 
 - Check out our `support channels`_
 
-.. _sidebartoc.html: src/crate/theme/rtd/crate/templates/crate/sidebartoc.html
+.. _sidebartoc.py: src/crate/theme/rtd/crate/sidebartoc.py
 .. _contribution docs: CONTRIBUTING.rst
 .. _Crate.io: https://cratedb.com
 .. _CrateDB documentation: https://cratedb.com/docs/

{crate_docs_theme-0.41.1.dev2 → crate_docs_theme-0.43.0}/README.rst

@@ -54,7 +54,7 @@ The documentation is composed of multiple separate documentation
 projects, interlinked via the CrateDB Documentation Theme.
 
 To update the root of the TOC sidebar for the entire documentation, update the
-`sidebartoc.html`` file.
+`sidebartoc.py`_ file.
 
 To use the theme, add this line to your Sphinx ``conf.py`` file::
 
@@ -80,7 +80,7 @@ Looking for more help?
 
 - Check out our `support channels`_
 
-.. _sidebartoc.html: src/crate/theme/rtd/crate/templates/crate/sidebartoc.html
+.. _sidebartoc.py: src/crate/theme/rtd/crate/sidebartoc.py
 .. _contribution docs: CONTRIBUTING.rst
 .. _Crate.io: https://cratedb.com
 .. _CrateDB documentation: https://cratedb.com/docs/

{crate_docs_theme-0.41.1.dev2 → crate_docs_theme-0.43.0}/setup.py

@@ -46,6 +46,7 @@ setup(
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
         "Topic :: Software Development :: Documentation",
     ],
     author="Crate.IO GmbH",
@@ -58,20 +59,18 @@ setup(
     include_package_data=True,
     zip_safe=False,
     install_requires=[
-        "furo==2025.7.19",
+        "furo==2025.9.25",
         "jinja2>=3,<4",
         "jupysql<0.12",
         "myst-nb<1.4",
         "myst-parser[linkify]<5",
-        "oembedpy>=0.8.1,<0.9",
         "snowballstemmer<4",
         "sphinx>=7.1,<9",
         "sphinx-basic-ng==1.0.0b2",
         "sphinx-copybutton>=0.3.1,<1",
-        "sphinx-design-elements==0.4.0",
+        "sphinx-design-elements==0.4.1",
         "sphinx-inline-tabs",
-        "sphinx-sitemap<2.8.0", #temporarily pinned due to build warnings with 2.7.0
-        "sphinx-subfigure<1",
+        "sphinx-sitemap<2.10.0",
         "sphinx-togglebutton<1",
         "sphinxext.opengraph>=0.4,<1",
         "sphinxcontrib-mermaid<2",

{crate_docs_theme-0.41.1.dev2 → crate_docs_theme-0.43.0}/src/crate/theme/rtd/__init__.py

@@ -22,37 +22,58 @@
 """CrateDB Sphinx theme for Read the Docs"""
 
 import os
+from .sidebartoc import generate_crate_navigation_html
 
-VERSION = (0, 41, 1)
+VERSION = (0, 43, 0)
 
-__version__ = ".".join(str(v) for v in VERSION) + ".dev2"
+__version__ = ".".join(str(v) for v in VERSION) # + ".dev0"
 __version_full__ = __version__
 
 
 def get_version():
     return __version__
 
-
 def current_dir():
     return os.path.abspath(os.path.dirname(__file__))
 
-
 def get_html_theme_path():
     """Return list of HTML theme paths."""
     return [current_dir()]
 
-
 def get_html_static_path():
     """Return list of HTML static paths."""
-    current_dir = current_dir()
-    return [
-        os.path.join(current_dir, "crate", "static"),
-    ]
-
+    return [os.path.join(current_dir(), "crate", "static")]
 
 def get_html_template_path():
     """Return list of HTML template paths."""
-    current_dir = current_dir()
-    return [
-        os.path.join(current_dir, "crate"),
-    ]
+    return [os.path.join(current_dir(), "crate")]
+
+
+def _add_crate_navigation(app, pagename, templatename, context, doctree):
+    """
+    Sphinx event handler: Add enhanced navigation to template context.
+
+    Generates multi-project navigation HTML and processes it through
+    Furo's navigation enhancer to add collapsible icons and checkboxes.
+    """
+
+    from furo.navigation import get_navigation_tree
+
+    navigation_html = generate_crate_navigation_html(context)
+
+    # Process through Furo's navigation enhancer
+    enhanced_navigation = get_navigation_tree(navigation_html)
+
+    # Add to context for use in templates
+    context["crate_navigation_tree"] = enhanced_navigation
+
+def setup(app):
+    """
+    Registers event handlers to setup navigation.
+    """
+    app.connect("html-page-context", _add_crate_navigation)
+    return {
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

{crate_docs_theme-0.41.1.dev2 → crate_docs_theme-0.43.0}/src/crate/theme/rtd/conf/__init__.py

@@ -33,14 +33,13 @@ exclude_patterns = [".*", "*.lint", "README.rst", "requirements.txt"]
 exclude_trees = ["pyenv", "tmp", "out", "parts", "clients", "eggs"]
 
 extensions = [
+    "crate.theme.rtd",  # CrateDB theme extension with Furo navigation integration
     "myst_nb",
-    "oembedpy.adapters.sphinx",
     "sphinx_copybutton",
     "sphinx_design",
     "sphinx_design_elements",
     "sphinx_inline_tabs",
     "sphinx_sitemap",
-    "sphinx_subfigure",
     "sphinx_togglebutton",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
@@ -84,7 +83,8 @@ html_theme_options = {
 }
 # https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html#fontawesome-icons
 html_css_files = [
-    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css"
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css",
+    # Note: furo-collapsible-toc.scss is bundled via index.css import
 ]
 
 html_extra_path = ["_extra"]
@@ -173,6 +173,8 @@ linkcheck_ignore = [
     "https://unsplash.com/.*",
     # [Errno 101] Network is unreachable
     "https://www.gnu.org/.*",
+    # Temporary failure in name resolution
+    "https://jupysql.ploomber.io/.*",
 ]
 linkcheck_anchors_ignore_for_url = [
     # Requires JavaScript.
@@ -202,9 +204,6 @@ myst_enable_extensions = [
 # -- Options for MyST-NB ----------------------------------------------
 nb_execution_raise_on_error = True
 
-# -- Options for oEmbedPy ---------------------------------------------
-oembed_fallback_type = True
-
 
 def setup(app):
 
@@ -343,6 +342,10 @@ def setup(app):
     app.connect("builder-inited", set_proxied_static_path)
     app.connect("builder-inited", apply_html_context_custom)
 
+    # Register stepper directive
+    from crate.theme.rtd.crate.directives import stepper
+    stepper.setup(app)
+
     return {
         "parallel_read_safe": True,
         "parallel_write_safe": True,

crate_docs_theme-0.43.0/src/crate/theme/rtd/crate/directives/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8; -*-
+# Directives for crate-docs-theme

crate_docs_theme-0.43.0/src/crate/theme/rtd/crate/directives/stepper.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8; -*-
+"""
+Stepper directive for step-by-step documentation.
+"""
+
+from docutils import nodes
+from sphinx.util.docutils import SphinxDirective
+
+
+# Define custom nodes
+class stepper_node(nodes.General, nodes.Element):
+    pass
+
+class step_node(nodes.General, nodes.Element):
+    pass
+
+class StepperDirective(SphinxDirective):
+    """Container for step-by-step instructions."""
+
+    has_content = True
+    option_spec = {
+        'class': str, # directives.class_option is for multiple classes
+    }
+
+    def run(self):
+        stepper = stepper_node()
+        stepper['classes'] = self.options.get('class', '').split() # Add custom classes if provided
+        self_content = nodes.paragraph()
+        self.state.nested_parse(self.content, self.content_offset, self_content)
+
+        step_number = 1
+        for child in self_content.children:
+            if isinstance(child, step_node):
+                child['step-number'] = step_number
+                step_number += 1
+            stepper += child # Add all children from self_content to stepper
+
+        return [stepper]
+
+
+class StepDirective(SphinxDirective):
+    """Individual step in a stepper."""
+
+    has_content = True
+    required_arguments = 1  # Step title
+    optional_arguments = 0
+    final_argument_whitespace = True  # Allow spaces in title
+    option_spec = {
+        'class': str,
+    }
+
+    def run(self):
+        step = step_node()
+        step['classes'] = ['stepper-step']
+        step['classes'].extend(self.options.get('class', '').split())
+
+        # Set title
+        step['step-title'] = self.arguments[0]
+
+        # Parse content
+        self.state.nested_parse(
+            self.content,
+            self.content_offset,
+            step
+        )
+        return [step]
+
+# HTML Translator functions
+def html_visit_stepper_node(self, node):
+    self.context.append('')
+    self.body.append(self.starttag(node, 'div', CLASS='stepper'))
+
+def html_depart_stepper_node(self, node):
+    self.body.append('</div>\n')
+    self.context.pop()
+
+def html_visit_step_node(self, node):
+    self.context.append('')
+    self.body.append(self.starttag(node, 'div', CLASS='stepper-step'))
+    self.body.append(f'<div class="stepper-header">')
+    self.body.append(f'<div class="stepper-number">{node.get("step-number", "")}</div>')
+    self.body.append(f'<div class="stepper-title">{node.get("step-title", "")}</div>')
+    self.body.append(f'</div>')
+    self.body.append(f'<div class="stepper-content">')
+
+def html_depart_step_node(self, node):
+    self.body.append('</div>\n') # Close stepper-content
+    self.body.append('</div>\n') # Close stepper-step
+    self.context.pop()
+
+
+def setup(app):
+    """Register the stepper directives and nodes."""
+    app.add_node(stepper_node, html=(html_visit_stepper_node, html_depart_stepper_node))
+    app.add_node(step_node, html=(html_visit_step_node, html_depart_step_node))
+
+    app.add_directive('stepper', StepperDirective)
+    app.add_directive('step', StepDirective)
+
+    return {
+        'version': '0.1',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

{crate_docs_theme-0.41.1.dev2 → crate_docs_theme-0.43.0}/src/crate/theme/rtd/crate/sidebar.html

@@ -8,7 +8,7 @@
     {% endif %}
   </div>
   {% endif %}
-  <nav class="bs-docs-sidenav bs-sidenav nav" role="complementary">
+  <nav class="bs-docs-sidenav sidebar-tree bs-sidenav nav" role="complementary">
 
     {% if theme_navbar_links %}
       {%- for link in theme_navbar_links %}

crate_docs_theme-0.43.0/src/crate/theme/rtd/crate/sidebartoc.html

@@ -0,0 +1,2 @@
+{# Enhanced navigation generated by Sphinx extension using Furo's navigation enhancer #}
+{{ crate_navigation_tree }}

crate_docs_theme-0.43.0/src/crate/theme/rtd/crate/static/bundle/545e2a01321b20c6484b.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><path d="M15.707 12l-5.647-5.646a.5.5 0 01.708-.708l6 6a.5.5 0 010 .708l-6 6a.5.5 0 01-.708-.708L15.707 12z"/></svg>