Package: nengo-sphinx-theme
Nengo Sphinx ThemeThis repository contains a Sphinx theme
for documentation of Nengo projects.
It is closely tied to theNengo website repositoryboth in look-and-feel and in code organization.
Most static assets,
including the CSS files needed for this theme,
are part of the Nengo website repository
in order to minimize duplication.
Development therefore happens across both repositories.
We also discourage the use of this theme
by any projects not hosted under thehttps://www.nengo.aidomain.PropsThe initial design of this theme was done in 2019
by a team atFusionbox,
who were lovely to work with.Release History20.9 (September 9, 2020)AddedAddedtagmanager_idtheme option to enable Google Tag Manager tracking.
Note thattagmanager_idtakes precedence overanalytics_id. (#63)Addedone_pagetheme option, which can be set to True for docs that include
all content on a single index page. (#59)Added custom 404 page. (#65)Addednengo_sphinx_theme.ext.sourcelinksextension which allows the autodoc
source links to point to a different site (like GitHub). (#66)ChangedSwapped position of “search” and “version” boxes (so search is at the top
and version is at the bottom). (#58)Added notification when viewing the development version of docs. (#62)FixedVersions listed in the dropdown will now be sorted correctly by number rather than
string (e.g. 1.10 will come after 1.2). (#58)Remove empty lines from version dropdown. (#58)1.2.2 (April 14, 2020)Fixednengo_sphinx_theme.ext.resolvedefaultswill not touch signatures unless they
contain aDefaultvalue.
(#54)nengo_sphinx_theme.ext.resolvedefaultswill also resolve module objects to the
module name (rather than the file path).
(#57)1.2.1 (March 19, 2019)AddedAdded theautoautosummary_change_modulesconfig option tonengo_sphinx_theme.ext.autoautosummary, which allows classes/functions
documented withautoautosummaryorautomoduleto be moved to a different
nominal namespace. (#52)Addednengo_sphinx_theme.ext.backoff, which monkeypatches the Sphinx
HTTP request functionality to add exponential backoff.
(#52)1.2.0 (November 14, 2019)AddedAdded an extension to handle redirecting old HTML pages to new ones.
(#48)1.1.0 (November 5, 2019)AddedAdded an extension with theAutoAutoSummarydirective, which will
automatically generate Sphinx AutoSummaries for modules and classes.
(#45)1.0.3 (September 13, 2019)ChangedUpdated header and footer to match changes to nengo.ai.
(#41)1.0.2 (August 5, 2019)FixedFixed the search box, which was hanging for many search terms.
(#28,#39)1.0.1 (July 16, 2019)ChangedFixed a missing divider in the documentation drop-down menu.1.0.0 (July 16, 2019)ChangedThe look-and-feel of the theme was completely redone.
(#35)This project is now licensed with the Nengo license.
(#35)0.12.0 (May 29, 2019)AddedAddednengo_sphinx_theme.ext.resolvedefaultsextension that will
automatically fill in the value ofnengo.Defaultvalues in__init__signatures.
(#33)0.11.0 (May 20, 2019)AddedAdded a theme option to enable Google Analytics tracking by
providing an ID.
(#30)FixedFixed an issue in which the dropdown overlay prevented clicks
after it had been hidden from mousing outside of it.
(#29)0.10.0 (March 30, 2019)FixedAddedbodyclass to main div for compatibility with sphinx 2.0.
(#26)0.9.0 (March 25, 2019)AddedAdded search box to sidebar.
(#25)