diff --git a/CHANGES.rst b/CHANGES.rst index adbc77b1..fcb35d65 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -5,6 +5,10 @@ CHANGES Unreleased ---------- +- Added support for including the entire level0 entries in the sidebar TOC for a +project. See the "CreateDB: Guide" project in the ``sidebartoc.html`` file for +how to do that. +- The Guide project is now utilizing this to show 3 top-level entries in the TOC. 2025/09/23 0.40.1 ----------------- diff --git a/DEVELOP.rst b/DEVELOP.rst index 41bf5142..a58ee06b 100644 --- a/DEVELOP.rst +++ b/DEVELOP.rst @@ -100,13 +100,27 @@ dynamically generated using the ``toctree`` directive, but you can also add static links to the sidebar TOC by editing the HTML file directly. This is where you add entries to the top level sections in the sidebar TOC. - Testing changes -=============== -If you want to see the effect of theme changes beyond the docs included in this project, -you can use the theme locally with any other docs project, by changing the projects -requirements.txt file to include the full path to local version of this project. -requirements.txt file to include the full path to the local version of this project. +--------------- +If you want to see the effect of theme changes beyond the docs included in this +project, you can use the theme locally with any other docs project by changing +the project's requirements.txt file to include the full path to the local +version of this project like this:: + + -e /full/path/to/crate-docs-theme + +Then, run ``make reset`` and ``make dev`` in the other project's ``docs`` +directory. + +.. note:: + + Since changes to CSS is packed into a bundle, you must run + ``make bundle-develop`` in the top-level directory of this project + whenever you make changes to CSS files. Or use ``make bundle-watch`` + to have the bundling process run continuously in the background. + + IF you are only changing .html files, you do not need to run the + bundling process. Release diff --git a/README.rst b/README.rst index c9a5c3f9..e8e22ea4 100644 --- a/README.rst +++ b/README.rst @@ -51,7 +51,10 @@ Configuration ------------- The documentation is composed of multiple separate documentation -projects, seamlessly interlinked via the CrateDB Documentation Theme. +projects, interlinked via the CrateDB Documentation Theme. + +To update the root of the TOC sidebar for the entire documentation, update the +`sidebartoc.html`` file. To use the theme, add this line to your Sphinx ``conf.py`` file:: @@ -77,7 +80,7 @@ Looking for more help? - Check out our `support channels`_ - +.. _sidebartoc.html: src/crate/theme/rtd/crate/templates/crate/sidebartoc.html .. _contribution docs: CONTRIBUTING.rst .. _Crate.io: https://cratedb.com .. _CrateDB documentation: https://cratedb.com/docs/ diff --git a/src/crate/theme/rtd/__init__.py b/src/crate/theme/rtd/__init__.py index b045236c..6f2359a4 100644 --- a/src/crate/theme/rtd/__init__.py +++ b/src/crate/theme/rtd/__init__.py @@ -25,7 +25,7 @@ VERSION = (0, 40, 1) -__version__ = ".".join(str(v) for v in VERSION) +__version__ = ".".join(str(v) for v in VERSION) # + ".dev0" __version_full__ = __version__ diff --git a/src/crate/theme/rtd/crate/sidebartoc.html b/src/crate/theme/rtd/crate/sidebartoc.html index dece555f..2f81b192 100644 --- a/src/crate/theme/rtd/crate/sidebartoc.html +++ b/src/crate/theme/rtd/crate/sidebartoc.html @@ -16,14 +16,27 @@ - - {% if project == 'CrateDB: Guide' and pagename == 'home/index' %} -