Skip to content

Latest commit

 

History

History
197 lines (135 loc) · 5.77 KB

CHANGES.rst

File metadata and controls

197 lines (135 loc) · 5.77 KB
Raw

Release History

20.10 (unreleased)

Added

  • Added analytics theme option to allow specifying any tracking code. (#75)

Changed

  • Now supports/requires Sphinx 7. (#80)

Removed

  • Removed analytics_id and tagmanager_id theme options. Use analytics to specify the full tracking code instead. (#75)
  • Removed backoff extension (no longer necessary, since Sphinx has this behaviour built in). (#80)

Fixed

  • Aliases of renamed classes will now be handled correctly. (#70)
  • Redirecting to an absolute URL from a file in a subdirectory now works. (#74)

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

  • Versions 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)

Fixed

  • nengo_sphinx_theme.ext.resolvedefaults will not touch signatures unless they contain a Default value. (#54)
  • nengo_sphinx_theme.ext.resolvedefaults will also resolve module objects to the module name (rather than the file path). (#57)

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

  • Fixed the search box, which was hanging for many search terms. (#28, #39)

1.0.1 (July 16, 2019)

Changed

  • Fixed a missing divider in the documentation drop-down menu.

1.0.0 (July 16, 2019)

Changed

  • The 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)

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)