Nengo-bones

=====================

**Added**

- The ``nengo_bones.templates`` module was added to consolidate code
that loads and renders templates. (`45`_)

**Changed**

- The ``docs/conf.py`` template has been updated for new versions of
Nengo Sphinx Theme. (`46`_)
- ``static.sh`` and ``examples.sh`` will now check any notebooks in the
``docs`` folder (not just ``docs/examples``). (`46`_)
- ``bones-check`` now checks that the content of the generated files
matches the expected content, rather than relying on version numbers.
This means most files will not need to be regenerated when new NengoBones
versions are released, and that ``bones-check`` will be sensitive to changes
within a dev version. (`45`_)

**Fixed**

- The ``static.sh``/``examples.sh`` script will no longer fail if there are no
notebooks in the ``docs`` folder. (`46`_)

.. _45: https://github.com/nengo/nengo-bones/pull/45
.. _46: https://github.com/nengo/nengo-bones/pull/46

====================

**Added**

- Added ``codespell_ignore_words`` option to ``static.sh.template``,
which is a list of words that ``codespell`` will ignore. (`35`_)
- Added ``analytics_id`` option to ``docs_conf.py.template``,
which will enable Google Analytics tracking. (`35`_)

**Changed**

- ``codespell`` will now ignore ``_vendor`` directories. (`36`_)

**Fixed**

- Fixed an issue with ``static.sh.template`` in which Python files
that were not converted from notebooks were deleted. (`16`_)

.. _16: https://github.com/nengo/nengo-bones/pull/16
.. _35: https://github.com/nengo/nengo-bones/pull/35
.. _36: https://github.com/nengo/nengo-bones/pull/36

====================

**Added**

- Added ``apt_install`` option that can be set in the ``jobs`` section to
``apt install`` any custom ``apt`` requirements for a job. (`14`_)
- Added templates for ``CONTRIBUTING.rst``, ``CONTRIBUTORS.rst``,
``LICENSE.rst``, ``MANIFEST.in``, ``docs/conf.py``, ``setup.cfg``, and
``setup.py`` (`17`_)
- Templates will now be automatically loaded from a ``<repo>/.templates``
directory if it exists. When overriding existing templates, the built-in
templates can be accessed in ``include`` and ``extend`` tags with the
``templates/`` prefix. (`17`_)
- Added ``flake8`` to the static check script. (`17`_)
- Added the ``bones-pr-number`` script to predict the next PR number for a
repository. This helps when writing a changelog entry before a PR has been
made. (`18`_)

**Changed**

- The Python version is now specified by the ``python`` option (instead of
``python_version``), for consistency with ``.travis.yml``. (`14`_)
- All ``nengo-bones`` scripts now start with ``bones-``, to make them easier
to find with autocompletion. ``generate-bones`` is now ``bones-generate``,
and ``check-bones`` is now ``bones-check``. (`18`_)

**Removed**

- Removed ``conda`` from the CI setup; all installations should be done
through ``pip`` instead. (`14`_)
- Removed the ``--template-dir`` option from the ``generate-bones`` script;
use a ``.templates`` directory instead. (`17`_)

**Fixed**

- Order of templated dicts should now be deterministic for
all Python versions. (`14`_)

.. _14: https://github.com/nengo/nengo-bones/pull/14
.. _17: https://github.com/nengo/nengo-bones/pull/17
.. _18: https://github.com/nengo/nengo-bones/pull/18

======================

Initial release of NengoBones!
Thanks to all of the contributors for making this possible!