diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 06bf8ad..6f722cd 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -3,27 +3,29 @@ Changelog
Versions follow `Semantic Versioning `_ (``..``).
+.. towncrier release notes start
+
v2.0.1 (2023-01-16)
-------------------
Features
^^^^^^^^
-* Can turn off the addition of documented objects to the TOC tree.
-* Added support for Python 3.11.
+- Can turn off the addition of documented objects to the TOC tree.
+- Added support for Python 3.11.
Bug Fixes
^^^^^^^^^
-* `#330 `: (Python)
+- `#330 `: (Python)
Render tuple values as tuples, not lists.
-* `#341 `: (Python)
+- `#341 `: (Python)
Fix module level assignments to class attributes being documented as
module level attributes.
-* (Python) Fix "bysource" sort order showing items in alphabetical order.
-* (Python) Use the correct directives for a variable type and value.
+- (Python) Fix "bysource" sort order showing items in alphabetical order.
+- (Python) Use the correct directives for a variable type and value.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Removed some autogenerated test data from the repository.
+- Removed some autogenerated test data from the repository.
v2.0.0 (2022-09-27)
@@ -32,8 +34,8 @@ v2.0.0 (2022-09-27)
Breaking Changes
^^^^^^^^^^^^^^^^
-* Dropped support for Sphinx <4.
-* `#352 `: (Python)
+- Dropped support for Sphinx <4.
+- `#352 `: (Python)
Properties are rendered with the ``property`` directive,
fixing support for Sphinx 5.2.
A new ``PythonPythonMapper`` object (``PythonProperty``) has been created
@@ -43,8 +45,8 @@ Breaking Changes
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Use https links where possible in documentation.
-* Pass correct argument types to ``status_iterator``.
+- Use https links where possible in documentation.
+- Pass correct argument types to ``status_iterator``.
V1.9.0 (2022-07-25)
@@ -53,33 +55,33 @@ V1.9.0 (2022-07-25)
Breaking Changes
^^^^^^^^^^^^^^^^
-* Dropped support for Python 3.6.
+- Dropped support for Python 3.6.
Features
^^^^^^^^
-* Added support for Python 3.10.
-* `#222 `:
+- Added support for Python 3.10.
+- `#222 `:
Marked extension as parallel read safe.
Bug Fixes
^^^^^^^^^
-* `#324 `: (Python)
+- `#324 `: (Python)
Fail elegantly when no source files are found.
-* (Python) Stop calling ``autodoc-process-docstring`` when docstring is empty.
+- (Python) Stop calling ``autodoc-process-docstring`` when docstring is empty.
Works around https://github.com/sphinx-doc/sphinx/issues/10701.
-* `#318 `: (Python)
+- `#318 `: (Python)
Fixed misaligned argument types on methods/classmethods when using type comments.
-* `#278 `: (Python)
+- `#278 `: (Python)
Limit signatures to 60 characters in summaries.
-* Fix keyerror when using markdown sources.
-* `#328 `: (Python)
+- Fix keyerror when using markdown sources.
+- `#328 `: (Python)
Fix kw-only marker getting ignored if first in the signature.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Fixed tests in Sphinx 5.
-* Fixed many typos throughout the documentation.
+- Fixed tests in Sphinx 5.
+- Fixed many typos throughout the documentation.
v1.8.4 (2021-08-16)
@@ -87,7 +89,7 @@ v1.8.4 (2021-08-16)
Bug Fixes
^^^^^^^^^
-* `#301 `: (Python)
+- `#301 `: (Python)
Fixed compatibility with astroid 2.7+.
@@ -96,13 +98,13 @@ v1.8.3 (2021-07-31)
Bug Fixes
^^^^^^^^^
-* `#299 `: (Python)
+- `#299 `: (Python)
Fixed incorrect indentation in generated documentation when a class with no
constructor has a summary line spanning multiple lines.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Fixed broken link to Jinja objects.inv.
+- Fixed broken link to Jinja objects.inv.
v1.8.2 (2021-07-26)
@@ -111,14 +113,14 @@ v1.8.2 (2021-07-26)
Bug Fixes
^^^^^^^^^
-* Fixed error when parsing a class with no constructor.
-* `#293 `:
+- Fixed error when parsing a class with no constructor.
+- `#293 `:
Fixed failure to build out of source conf.py files.
Configuration values using relative values are now relative to the source directory
instead of relative to the conf.py file.
-* `#289 `: (Python)
+- `#289 `: (Python)
Fixed AttributeError using inheritance diagrams on a module with plain imports.
-* `#292 `:
+- `#292 `:
Explicitly use the domain for generated directives.
@@ -128,7 +130,7 @@ v1.8.1 (2021-04-24)
Bug Fixes
^^^^^^^^^
-* `#273 `:
+- `#273 `:
Fixed type annotations being shown for only a single module.
@@ -138,38 +140,38 @@ v1.8.0 (2021-04-12)
Features
^^^^^^^^
-* Expandable value for multi-line string attributes.
-* `#265 `:
+- Expandable value for multi-line string attributes.
+- `#265 `:
Can resolve the qualified paths of parameters to generics.
-* `#275 `:
+- `#275 `:
Warnings have been categorised and can be suppressed through ``suppress_warnings``.
-* `#280 `:
+- `#280 `:
Data attributes are documented in module summaries.
Bug Fixes
^^^^^^^^^
-* `#273 `:
+- `#273 `:
Fixed setting ``autodoc_typehints`` to ``none`` or ``description``
not turning off signature type hints.
``autodoc_typehints`` integration is considered experimental until
the extension properly supports overload functions.
-* `#261 `:
+- `#261 `:
Fixed data annotations causing pickle or deepcopy errors.
-* Documentation can be generated when multiple source directories
+- Documentation can be generated when multiple source directories
share a single ``conf.py`` file.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Fixed ``DeprecationWarning`` for invalid escape sequence ``\s`` in tests.
-* Fixed ``FutureWarning`` for ``Node.traverse()`` becoming an iterator instead of list.
-* New example implementation of ``autoapi-skip-member`` Sphinx event.
-* Can run tests with tox 4.
-* Updated packaging to use PEP-517.
-* All unittest style tests have been converted to pytest style tests.
-* An exception raised by docfx is raised directly instead of wrapping it.
-* Started using Github Actions for continuous integration.
+- Fixed ``DeprecationWarning`` for invalid escape sequence ``\s`` in tests.
+- Fixed ``FutureWarning`` for ``Node.traverse()`` becoming an iterator instead of list.
+- New example implementation of ``autoapi-skip-member`` Sphinx event.
+- Can run tests with tox 4.
+- Updated packaging to use PEP-517.
+- All unittest style tests have been converted to pytest style tests.
+- An exception raised by docfx is raised directly instead of wrapping it.
+- Started using Github Actions for continuous integration.
V1.7.0 (2021-01-31)
@@ -178,17 +180,17 @@ V1.7.0 (2021-01-31)
Features
^^^^^^^^
-* The fully qualified path of objects are included type annotations
+- The fully qualified path of objects are included type annotations
so that Sphinx can link to them.
-* Added support for Sphinx 3.3. and 3.4.
-* `#240 `:
+- Added support for Sphinx 3.3. and 3.4.
+- `#240 `:
The docstrings of ``object.__init__``, ``object.__new__``,
``type.__init__``, and ``type.__new__`` are not inherited.
Bug Fixes
^^^^^^^^^
-* `#260 `:
+- `#260 `:
The overload signatures of ``__init__`` methods are documented.
@@ -198,33 +200,33 @@ V1.6.0 (2021-01-20)
Breaking Changes
^^^^^^^^^^^^^^^^
-* Dropped support for Python 2 and Sphinx 1.x/2.x.
+- Dropped support for Python 2 and Sphinx 1.x/2.x.
Python 2 source code can still be parsed.
Features
^^^^^^^^
-* (Python) Added support for using type hints as parameter types and return types
+- (Python) Added support for using type hints as parameter types and return types
via the ``sphinx.ext.autodoc.typehints`` extension.
-* `#191 `:
+- `#191 `:
Basic incremental build support is enabled ``autoapi_keep_files`` is enabled.
Providing none of the source files have changed,
AutoAPI will skip parsing the source code and regenerating the API documentation.
-* `#200 `:
+- `#200 `:
Can pass a callback that edits the Jinja Environment object before
template rendering begins.
This allows custom filters, tests, and globals to be added to the environment.
-* Added support for Python 3.9.
+- Added support for Python 3.9.
Bug Fixes
^^^^^^^^^
-* `#246 `: (Python)
+- `#246 `: (Python)
Fixed TypeError when parsing a class that inherits from ``type``.
-* `#244 `:
+- `#244 `:
Fixed an unnecessary deprecation warning being raised when running
sphinx-build from the same directory as conf.py.
-* (Python) Fixed properties documented by Autodoc directives getting documented as methods.
+- (Python) Fixed properties documented by Autodoc directives getting documented as methods.
V1.5.1 (2020-10-01)
@@ -233,7 +235,7 @@ V1.5.1 (2020-10-01)
Bug Fixes
^^^^^^^^^
-* Fixed AttributeError when generating an inheritance diagram for a module.
+- Fixed AttributeError when generating an inheritance diagram for a module.
V1.5.0 (2020-08-31)
@@ -244,28 +246,28 @@ This will be the last minor version to support Python 2 and Sphinx 1.x/2.x.
Features
^^^^^^^^
-* `#222 `:
+- `#222 `:
Declare the extension as parallel unsafe.
-* `#217 `: (Python)
+- `#217 `: (Python)
All overload signatures are documented.
-* `#243 `:
+- `#243 `:
Files are found in order of preference according to ``autoapi_file_patterns``.
-* Added support for Sphinx 3.2.
+- Added support for Sphinx 3.2.
Bug Fixes
^^^^^^^^^
-* `#219 `: (Python)
+- `#219 `: (Python)
Fixed return types not showing for methods.
-* (Python) Fixed incorrect formatting of properties on generated method directives.
-* Fixed every toctree entry getting added as a new list.
-* `#234 `:
+- (Python) Fixed incorrect formatting of properties on generated method directives.
+- Fixed every toctree entry getting added as a new list.
+- `#234 `:
Fixed only some entries getting added to the toctree.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* autoapisummary directive inherits from autosummary for future stability.
+- autoapisummary directive inherits from autosummary for future stability.
v1.4.0 (2020-06-07)
@@ -274,16 +276,16 @@ v1.4.0 (2020-06-07)
Features
^^^^^^^^
-* `#197 `: Added
+- `#197 `: Added
``autoapi.__version__`` and ``autoapi.__version_info__`` attributes
for accessing version information.
-* `#201 `: (Python)
+- `#201 `: (Python)
Added the ``autoapi_member_order`` option to allow the order that members
are documented to be configurable.
-* `#203 `: (Python)
+- `#203 `: (Python)
A class without a docstring inherits one from its parent.
A methods without a docstring inherits one from the method that it overrides.
-* `#204 `: (Python)
+- `#204 `: (Python)
Added the ``imported-members`` AutoAPI option to be able to enable or disable
documenting objects imported from the same top-level package or module
without needing to override templates.
@@ -291,22 +293,22 @@ Features
Bug Fixes
^^^^^^^^^
-* `#198 `:
+- `#198 `:
Documentation describes the required layout for template override directories.
-* `#195 `: (Python)
+- `#195 `: (Python)
Fixed incorrect formatting when ``show-inheritance-diagram``
and ``private-members`` are turned on.
-* `#193 ` and
+- `#193 ` and
`#208 `: (Python)
Inheritance diagrams can follow imports to find classes to document.
-* `#213 `: (Python)
+- `#213 `: (Python)
Fixed module summary never showing.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* black shows diffs by default
-* `#207 `:
+- black shows diffs by default
+- `#207 `:
Fixed a typo in the code of the golang tutorial.
@@ -316,45 +318,45 @@ v1.3.0 (2020-04-05)
Breaking Changes
^^^^^^^^^^^^^^^^
-* Dropped support for Python 3.4 and 3.5.
+- Dropped support for Python 3.4 and 3.5.
Features
^^^^^^^^
-* `#151 `: (Python)
+- `#151 `: (Python)
Added the ``autoapi_python_use_implicit_namespaces`` option to allow
AutoAPI to search for implicit namespace packages.
-* Added support for Sphinx 2.2 and 2.3.
-* Added support for Python 3.8.
-* `#140 `: (Python)
+- Added support for Sphinx 2.2 and 2.3.
+- Added support for Python 3.8.
+- `#140 `: (Python)
Added the ``autoapi-inheritance-diagram`` directive to create
inheritance diagrams without importing modules.
Enable the ``show-inheritance-diagram`` AutoAPI option to
turn the diagrams on in generated documentation.
-* `#183 `: (Python)
+- `#183 `: (Python)
Added the ``show-inheritance`` AutoAPI option to be able to enable or disable
the display of a list of base classes in generated documentation about a class.
Added the ``inherited-members`` AutoAPI option to be able to enable or disable
the display of members inherited from a base class
in generated documentation about a class.
-* The ``autoapi_include_summaries`` option has been replaced with the
+- The ``autoapi_include_summaries`` option has been replaced with the
``show-module-summary`` AutoAPI option.
``autoapi_include_summaries`` will stop working in the next major version.
-* Added support for Sphinx 2.4 and 3.0
+- Added support for Sphinx 2.4 and 3.0
Bug Fixes
^^^^^^^^^
-* `#186 `: (Python)
+- `#186 `: (Python)
Fixed an exception when there are too many argument type annotations
in a type comment.
-* (Python) args and kwargs type annotations can be read from
+- (Python) args and kwargs type annotations can be read from
the function type comment.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Tests are now included in the sdist.
+- Tests are now included in the sdist.
v1.2.1 (2019-10-09)
@@ -363,7 +365,7 @@ v1.2.1 (2019-10-09)
Bug Fixes
^^^^^^^^^
-* (Python) "Invalid desc node" warning no longer raised for autodoc-style
+- (Python) "Invalid desc node" warning no longer raised for autodoc-style
directives.
@@ -373,21 +375,21 @@ v1.2.0 (2019-10-05)
Features
^^^^^^^^
-* (Python) Can read per argument type comments with astroid > 2.2.5.
-* (Python) Added autoapidecorator directive with Sphinx >= 2.0.
-* (Python) Can use autodoc_docstring_signature with Autodoc-style directives.
-* (Python) Added autoapi-skip-member event.
-* Made it more clear which file causes an error, when an error occurs.
-* Sphinx language domains are now optional dependencies.
+- (Python) Can read per argument type comments with astroid > 2.2.5.
+- (Python) Added autoapidecorator directive with Sphinx >= 2.0.
+- (Python) Can use autodoc_docstring_signature with Autodoc-style directives.
+- (Python) Added autoapi-skip-member event.
+- Made it more clear which file causes an error, when an error occurs.
+- Sphinx language domains are now optional dependencies.
Bug Fixes
^^^^^^^^^
-* (Python) Forward reference annotations are no longer rendered as strings.
-* (Python) autoapifunction directive no longer documents async functions as
+- (Python) Forward reference annotations are no longer rendered as strings.
+- (Python) autoapifunction directive no longer documents async functions as
a normal function.
-* (Python) Fixed unicode decode errors in some Python 3 situations.
-* Documentation more accurately describes what configuration accepts
+- (Python) Fixed unicode decode errors in some Python 3 situations.
+- Documentation more accurately describes what configuration accepts
relative paths and where they are relative to.
@@ -397,19 +399,19 @@ v1.1.0 (2019-06-23)
Features
^^^^^^^^
-* (Python) Can override ignoring local imports in modules by using __all__.
+- (Python) Can override ignoring local imports in modules by using __all__.
Bug Fixes
^^^^^^^^^
-* (Python) Fixed incorrect formatting of functions and methods.
-* Added support for Sphinx 2.1.
+- (Python) Fixed incorrect formatting of functions and methods.
+- Added support for Sphinx 2.1.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Fixed some dead links in the README.
-* Fixed lint virtualenv.
+- Fixed some dead links in the README.
+- Fixed lint virtualenv.
v1.0.0 (2019-04-24)
@@ -418,30 +420,30 @@ v1.0.0 (2019-04-24)
Features
^^^^^^^^
-* `#100 `: (Python)
+- `#100 `: (Python)
Added support for documenting C extensions via ``.pyi`` stub files.
-* Added support for Sphinx 2.0.
-* Toned down the API reference index page.
-* (Go) Patterns configured in ``autoapi_ignore`` are passed to godocjson.
-* New and improved documentation.
-* No longer need to set ``autoapi_add_toctree_entry`` to False when ``autoapi_generate_api_docs`` is False.
-* `#139 `
+- Added support for Sphinx 2.0.
+- Toned down the API reference index page.
+- (Go) Patterns configured in ``autoapi_ignore`` are passed to godocjson.
+- New and improved documentation.
+- No longer need to set ``autoapi_add_toctree_entry`` to False when ``autoapi_generate_api_docs`` is False.
+- `#139 `
Added support for basic type annotations in documentation generation and autodoc-style directives.
Bug Fixes
^^^^^^^^^
-* `#159 `: (Python)
+- `#159 `: (Python)
Fixed ``UnicodeDecodeError`` on Python 2 when a documenting an attribute that contains binary data.
-* (Python) Fixed private submodules displaying when ``private-members`` is turned off.
-* Templates no longer produce excessive whitespace.
-* (Python) Fixed an error when giving an invalid object to an autodoc-style directive.
+- (Python) Fixed private submodules displaying when ``private-members`` is turned off.
+- Templates no longer produce excessive whitespace.
+- (Python) Fixed an error when giving an invalid object to an autodoc-style directive.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* No longer pin the version of black.
-* Added missing test environments to travis.
+- No longer pin the version of black.
+- Added missing test environments to travis.
v0.7.1 (2019-02-04)
@@ -450,7 +452,7 @@ v0.7.1 (2019-02-04)
Bug Fixes
^^^^^^^^^
-* (Python) Fixed a false warning when importing a local module.
+- (Python) Fixed a false warning when importing a local module.
v0.7.0 (2019-01-30)
@@ -459,17 +461,17 @@ v0.7.0 (2019-01-30)
Breaking Changes
^^^^^^^^^^^^^^^^
-* Dropped support for Sphinx<1.6.
+- Dropped support for Sphinx<1.6.
Features
^^^^^^^^
-* Added debug messages about what AutoAPI is doing.
+- Added debug messages about what AutoAPI is doing.
Bug Fixes
^^^^^^^^^
-* `#156 `: (Python) Made import resolution more stable.
+- `#156 `: (Python) Made import resolution more stable.
Also capable of giving more detailed warnings.
@@ -477,10 +479,10 @@ Bug Fixes
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Code is now formatted using black.
-* Removed references to old css and js files.
-* Replaced usage of deprecated Sphinx features.
-* Reorganised tests to be more pytest-like.
+- Code is now formatted using black.
+- Removed references to old css and js files.
+- Replaced usage of deprecated Sphinx features.
+- Reorganised tests to be more pytest-like.
v0.6.2 (2018-11-15)
@@ -489,7 +491,7 @@ v0.6.2 (2018-11-15)
Bug Fixes
^^^^^^^^^
-* (Python) Fixed some import chains failing to resolve depending on resolution order.
+- (Python) Fixed some import chains failing to resolve depending on resolution order.
v0.6.1 (2018-11-14)
@@ -498,18 +500,18 @@ v0.6.1 (2018-11-14)
Bug Fixes
^^^^^^^^^
-* (Python) Fixed unicode decoding on Python 3.7.
-* (Python) Fixed autodoc directives not documenting anything in submodules or subpackages.
-* (Python) Fixed error parsing files with unicode docstrings.
-* (Python) Fixed error when documenting something that's imported in more than one place.
+- (Python) Fixed unicode decoding on Python 3.7.
+- (Python) Fixed autodoc directives not documenting anything in submodules or subpackages.
+- (Python) Fixed error parsing files with unicode docstrings.
+- (Python) Fixed error when documenting something that's imported in more than one place.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* (Python) Added Python 3.7 testing.
-* Started testing against stable version of Sphinx 1.8.
-* Fixed all "no title" warnings during tests.
+- (Python) Added Python 3.7 testing.
+- Started testing against stable version of Sphinx 1.8.
+- Fixed all "no title" warnings during tests.
v0.6.0 (2018-08-20)
@@ -518,51 +520,51 @@ v0.6.0 (2018-08-20)
Breaking Changes
^^^^^^^^^^^^^^^^
-* `#152 `: Removed the ``autoapi_add_api_root_toctree`` option.
+- `#152 `: Removed the ``autoapi_add_api_root_toctree`` option.
This has been replaced with the ``autoapi_add_toctree_entry`` option.
-* `#25 `: Removed distutils support.
-* Removed redundant ``package_dir`` and ``package_data`` options.
+- `#25 `: Removed distutils support.
+- Removed redundant ``package_dir`` and ``package_data`` options.
Features
^^^^^^^^
-* (Python) Added viewcode support for imported members.
-* `#146 `: (Python) No longer documents ``__init__()`` attributes without a docstring.
-* `#153 `: (Python) Can document a public python API.
-* `#111 `: (Python) Can opt to write manual documentation through new autodoc-style directives.
-* `#152 `: Made it easier to remove default index page.
+- (Python) Added viewcode support for imported members.
+- `#146 `: (Python) No longer documents ``__init__()`` attributes without a docstring.
+- `#153 `: (Python) Can document a public python API.
+- `#111 `: (Python) Can opt to write manual documentation through new autodoc-style directives.
+- `#152 `: Made it easier to remove default index page.
Also removed autoapi_add_api_root_toctree config option
-* `#150 `: (Python) ``private-members`` also controls private subpackages and submodules.
-* (Python) Added support for static and class methods.
-* (Python) Methods include ``self`` in their arguments.
+- `#150 `: (Python) ``private-members`` also controls private subpackages and submodules.
+- (Python) Added support for static and class methods.
+- (Python) Methods include ``self`` in their arguments.
This more closely matches autodoc behaviour.
-* `#145 `: (Python) Added support for detecting Python exceptions.
-* (Python) Can control how __init__ docstring is displayed.
-* (Python) Added support for viewcode.
-* (Python) Source files no longer need to be in ``sys.path``.
+- `#145 `: (Python) Added support for detecting Python exceptions.
+- (Python) Can control how __init__ docstring is displayed.
+- (Python) Added support for viewcode.
+- (Python) Source files no longer need to be in ``sys.path``.
Bug Fixes
^^^^^^^^^
-* (Python) Fixed linking to builtin bases.
-* (Python) Fixed properties being documented more than once when set in ``__init__()``.
-* (Python) Fixed nested classes not getting displayed.
-* `#148 `: (Python) Fixed astroid 2.0 compatibility.
-* (Python) Fixed filtered classes and attributes getting displayed.
-* (Python) Fixed incorrect display of long lists.
-* `#125 `: (Javascript) Fixed running incorrect jsdoc command on Windows.
-* `#125 `: (Python) Support specifying package directories in ``autoapi_dirs``.
+- (Python) Fixed linking to builtin bases.
+- (Python) Fixed properties being documented more than once when set in ``__init__()``.
+- (Python) Fixed nested classes not getting displayed.
+- `#148 `: (Python) Fixed astroid 2.0 compatibility.
+- (Python) Fixed filtered classes and attributes getting displayed.
+- (Python) Fixed incorrect display of long lists.
+- `#125 `: (Javascript) Fixed running incorrect jsdoc command on Windows.
+- `#125 `: (Python) Support specifying package directories in ``autoapi_dirs``.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
-* Added Sphinx 1.7 and 1.8.0b1 testing.
-* `#120 `: Updated documentation to remove outdated references.
-* Removed old testing dependencies.
-* `#143 `: Removed unnecessary wheel dependency.
+- Added Sphinx 1.7 and 1.8.0b1 testing.
+- `#120 `: Updated documentation to remove outdated references.
+- Removed old testing dependencies.
+- `#143 `: Removed unnecessary wheel dependency.
diff --git a/docs/changes/+e2fe0940.misc.rst b/docs/changes/+e2fe0940.misc.rst
new file mode 100644
index 0000000..6d2019b
--- /dev/null
+++ b/docs/changes/+e2fe0940.misc.rst
@@ -0,0 +1,2 @@
+
+Integrated towncrier into the release workflow.
diff --git a/docs/changes/.gitkeep b/docs/changes/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/docs/maintenance/release-process.rst b/docs/maintenance/release-process.rst
index e7fa2a1..b80cffc 100644
--- a/docs/maintenance/release-process.rst
+++ b/docs/maintenance/release-process.rst
@@ -15,10 +15,9 @@ Preparation
-----------
1. Update the version numbers in ``autoapi/__init__.py``.
-2. Add any missing changelog entries.
-3. Put the version number and release date into the changelog.
-4. Commit and push the changes.
-5. Check that the tests passed on github.
+2. Run ``tox -e release_notes -- build``
+3. Commit and push the changes.
+4. Check that the tests passed on github.
Release
-------
diff --git a/pyproject.toml b/pyproject.toml
index ead8162..642482e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,3 +1,10 @@
[build-system]
requires = ["setuptools>=46.4.0", "wheel"]
build-backend = "setuptools.build_meta"
+
+[tool.towncrier]
+directory = "docs/changes"
+filename = "CHANGELOG.rst"
+package = "autoapi"
+title_format = "v{version} ({project_date})"
+underlines = ["-", "^", "\""]
diff --git a/tox.ini b/tox.ini
index 539b38e..d4f2aca 100644
--- a/tox.ini
+++ b/tox.ini
@@ -6,6 +6,7 @@ envlist =
formatting
lint
docs
+ release_notes
[testenv]
extras =
@@ -38,6 +39,12 @@ changedir = {toxinidir}/docs
commands =
sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
+[testenv:release_notes]
+deps =
+ towncrier
+commands =
+ towncrier {posargs:check}
+
[testenv:release]
skip_install = true
deps =