Metadata-Version: 2.1
Name: nengo-sphinx-theme
Version: 1.1.0
Summary: Sphinx theme for Nengo project documentation pages
Home-page: https://www.nengo.ai/nengo-sphinx-theme
Author: Applied Brain Research
Author-email: info@appliedbrainresearch.com
License: Free for non-commercial use
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Nengo
Classifier: Intended Audience :: Developers
Classifier: License :: Free for non-commercial use
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development
Requires-Python: >=3.5
Requires-Dist: sphinx (>=1.8)
Provides-Extra: all
Requires-Dist: jupyter ; extra == 'all'
Requires-Dist: matplotlib ; extra == 'all'
Requires-Dist: nbsphinx ; extra == 'all'
Requires-Dist: nengo ; extra == 'all'
Requires-Dist: numpydoc ; extra == 'all'
Provides-Extra: docs
Requires-Dist: jupyter ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: nengo ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Provides-Extra: optional
Provides-Extra: tests

******************
Nengo Sphinx Theme
******************

This repository contains a Sphinx theme
for documentation of Nengo projects.
It is closely tied to the `Nengo website repository
<https://github.com/nengo/nengo.github.io>`_
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 <https://www.fusionbox.com/>`_,
who were lovely to work with.

***************
Release History
***************

.. Changelog entries should follow this format:

   version (release date)
   ======================

   **section**

   - One-line description of change (link to Github issue/PR)

.. Changes should be organized in one of several sections:

   - Added
   - Changed
   - Deprecated
   - Removed
   - Fixed

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 <https://github.com/nengo/nengo-sphinx-theme/pull/45>`__)

1.0.3 (September 13, 2019)
==========================

**Changed**

- Updated header and footer to match changes to nengo.ai.
  (`#41 <https://github.com/nengo/nengo-sphinx-theme/pull/41>`__)

1.0.2 (August 5, 2019)
======================

**Fixed**

- Fixed the search box, which was hanging for many search terms.
  (`#28 <https://github.com/nengo/nengo-sphinx-theme/issues/28>`__,
  `#39 <https://github.com/nengo/nengo-sphinx-theme/pull/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 <https://github.com/nengo/nengo-sphinx-theme/pull/35>`__)
- This project is now licensed with the Nengo license.
  (`#35 <https://github.com/nengo/nengo-sphinx-theme/pull/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 <https://github.com/nengo/nengo-sphinx-theme/pull/33>`_)

0.11.0 (May 20, 2019)
=====================

**Added**

- Added a theme option to enable Google Analytics tracking by
  providing an ID.
  (`#30 <https://github.com/nengo/nengo-sphinx-theme/pull/30>`__)

**Fixed**

- Fixed an issue in which the dropdown overlay prevented clicks
  after it had been hidden from mousing outside of it.
  (`#29 <https://github.com/nengo/nengo-sphinx-theme/pull/29>`__)

0.10.0 (March 30, 2019)
=======================

**Fixed**

- Added ``body`` class to main div for compatibility with sphinx 2.0.
  (`#26 <https://github.com/nengo/nengo-sphinx-theme/pull/26>`__)

0.9.0 (March 25, 2019)
======================

**Added**

- Added search box to sidebar.
  (`#25 <https://github.com/nengo/nengo-sphinx-theme/pull/25>`__)


