Nengo Sphinx Theme
This repository contains a Sphinx theme for documentation of Nengo projects. It is closely tied to the Nengo website repository both 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 the https://www.nengo.ai domain.
Props
The initial design of this theme was done in 2019 by a team at Fusionbox, who were lovely to work with.
Release History
20.9 (September 9, 2020)
Added
Added tagmanager_id theme option to enable Google Tag Manager tracking. Note that tagmanager_id takes precedence over analytics_id. (#63)
Added one_page theme option, which can be set to True for docs that include all content on a single index page. (#59)
Added custom 404 page. (#65)
Added nengo_sphinx_theme.ext.sourcelinks extension which allows the autodoc source links to point to a different site (like GitHub). (#66)
Changed
Swapped 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)
Fixed
1.2.2 (April 14, 2020)
Fixed
1.2.1 (March 19, 2019)
Added
Added the autoautosummary_change_modules config option to nengo_sphinx_theme.ext.autoautosummary, which allows classes/functions documented with autoautosummary or automodule to be moved to a different nominal namespace. (#52)
Added nengo_sphinx_theme.ext.backoff, which monkeypatches the Sphinx HTTP request functionality to add exponential backoff. (#52)
1.2.0 (November 14, 2019)
Added
Added an extension to handle redirecting old HTML pages to new ones. (#48)
1.1.0 (November 5, 2019)
Added
Added an extension with the AutoAutoSummary directive, which will automatically generate Sphinx AutoSummaries for modules and classes. (#45)
1.0.3 (September 13, 2019)
Changed
Updated header and footer to match changes to nengo.ai. (#41)
1.0.2 (August 5, 2019)
Fixed
1.0.1 (July 16, 2019)
Changed
Fixed a missing divider in the documentation drop-down menu.
1.0.0 (July 16, 2019)
Changed
0.12.0 (May 29, 2019)
Added
Added nengo_sphinx_theme.ext.resolvedefaults extension that will automatically fill in the value of nengo.Default values in __init__ signatures. (#33)
0.11.0 (May 20, 2019)
Added
Added a theme option to enable Google Analytics tracking by providing an ID. (#30)
Fixed
Fixed 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)
Fixed
Added body class to main div for compatibility with sphinx 2.0. (#26)
0.9.0 (March 25, 2019)
Added
Added search box to sidebar. (#25)
Release files for nengo-sphinx-theme 20.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| nengo-sphinx-theme-20.9.tar.gz | 29.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nengo_sphinx_theme-20.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 49.3 kB
Release files / nengo-sphinx-theme-20.9.tar.gz
| Download URL | nengo-sphinx-theme-20.9.tar.gz |
|---|---|
| Size | 29.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3c7a0d5bec5b45b6c77962146c91f877e49b43b33a17ad35ef0192a2e12f68e1
|
|
BLAKE2b-256 checksum How to use checksums |
b34f5222719e93f5a967f2776b15b88061be610069d5240c6b7b208ba7d50877
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7
|
Release files / nengo_sphinx_theme-20.9-py3-none-any.whl
| Download URL | nengo_sphinx_theme-20.9-py3-none-any.whl |
|---|---|
| Size | 20.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9d66022bf52f2b0bbfabfa44ef27c7e108bf07d5588dd2ef3d5064962df91f2
|
|
BLAKE2b-256 checksum How to use checksums |
a8bfde9a3b508a6074ffdd6d6d8f4fefc16ee4754fc9dde82b705a7fb4669547
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7
|
Security for nengo-sphinx-theme 20.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
