Package: lsst-dd-rtd-theme
Forked fromhttp://github.com/snide/sphinx_rtd_theme.ContentsUsing itChangelog0.2.4 (2021-11-08)0.2.3 (2020-01-22)v0.1.8How the Table of Contents buildsContributing or modifying the themeSet up your environmentUsing itIn yourrequirements.txtadd:lsst-dd-rtd-themeIn yourconf.pyfile:importlsst_dd_rtd_themehtml_theme="lsst_dd_rtd_theme"html_theme_path=[lsst_dd_rtd_theme.get_html_theme_path()]Changelog0.2.4 (2021-11-08)Fix unordered list formatting with recent dependency sets.0.2.3 (2020-01-22)Modernize packaging withpyproject.tomlandsetup.cfgfiles.
We’re also usingsetuptools_scmnow.
In doing this, we’ve cleaned up many packaging metadata errors present in earlier releases.Use Travis CI to release to PyPI.v0.1.8Start keeping changelog :)Support for third and fourth level headers in the sidebarAdd support for Sphinx 1.3Add sidebar headers for :caption: in Sphinx toctreeClean up sidebar scrolling behavior so it never scrolls out of viewHow the Table of Contents buildsCurrently the left menu will build based upon anytoctree(s)defined in your index.rst file.
It outputs 2 levels of depth, which should give your visitors a high level of access to your
docs. If no toctrees are set the theme reverts to sphinx’s usual local toctree.It’s important to note that if you don’t follow the same styling for your rST headers across
your documents, the toctree will misbuild, and the resulting menu might not show the correct
depth when it renders.Also note that the table of contents is set withincludehidden=true. This allows you
to set a hidden toc in your index file with thehiddenproperty that will allow you
to build a toc without it rendering in your index.By default, the navigation will “stick” to the screen as you scroll. However if your toc
is vertically too large, it will revert to static positioning. To disable the sticky nav
altogether change the setting inconf.py.Contributing or modifying the themeThe lsst_dd_rtd_theme is primarily asassproject that requires a few other sass libraries. I’m
usingbowerto manage these dependencies andsassto build the css. The good news is
I have a very nice set ofgruntoperations that will not only load these dependencies, but watch
for changes, rebuild the sphinx demo docs and build a distributable version of the theme.
The bad news is this means you’ll need to set up your environment similar to that
of a front-end developer (vs. that of a python developer). That means installing node and ruby.Set up your environmentInstallsphinxinto a virtual environment.pip install sphinxInstall sassgem install sassInstall node, bower and grunt.// Install node
brew install node

// Install bower and grunt
npm install -g bower grunt-cli

// Now that everything is installed, let's install the theme dependecies.
npm installNow that our environment is set up, make sure you’re in your virtual environment, go to
this repository in your terminal and run grunt:gruntThis default task will do the followingvery cool things that make it worth the trouble.It’ll install and update any bower dependencies.It’ll run sphinx and build new docs.It’ll watch for changes to the sass files and build css from the changes.It’ll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js
or .css files.