2019-04-07 00:56:05 +00:00
Changelog
=========
Versions follow `Semantic Versioning <https://semver.org/> `_ (`` <major>.<minor>.<patch> `` ).
2021-02-15 14:07:02 +00:00
UNRELEASED (TBC)
----------------
Features
^^^^^^^^
2021-03-20 06:11:52 +00:00
* Expandable value for multi-line string attributes.
* `#265 <https://github.com/readthedocs/sphinx-autoapi/issues/265>`
Can resolve the qualified paths of parameters to generics.
2021-02-15 13:37:52 +00:00
2021-04-03 02:24:18 +00:00
Bug Fixes
^^^^^^^^^
* `#273 <https://github.com/readthedocs/sphinx-autoapi/issues/273>`
Fixed setting `` autodoc_typehints `` to `` none `` or `` description ``
not turning off signature type hints.
`` autodoc_typehints `` integration is consisidered experimental until
the extension properly supports overload functions.
2021-04-03 03:57:06 +00:00
* `#261 <https://github.com/readthedocs/sphinx-autoapi/issues/261>`
Fixed data annotations causing pickle or deepcopy errors.
2021-04-03 02:24:18 +00:00
2021-02-15 13:37:52 +00:00
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
2021-04-03 02:24:18 +00:00
* 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.
2021-04-03 02:20:16 +00:00
* Can run tests with tox 4.
2021-04-04 01:39:08 +00:00
* Updated packaging to use PEP-517.
2021-04-04 02:01:27 +00:00
* All unittest style tests have been converted to pytest style tests.
2021-02-15 13:37:52 +00:00
2021-02-01 06:26:44 +00:00
V1.7.0 (2021-01-31)
-------------------
2021-01-31 18:11:30 +00:00
Features
^^^^^^^^
2021-01-31 18:14:52 +00:00
* The fully qualified path of objects are included type annotations
so that Sphinx can link to them.
2021-01-31 18:11:30 +00:00
* Added support for Sphinx 3.3. and 3.4.
2021-02-01 00:12:19 +00:00
* `#240 <https://github.com/readthedocs/sphinx-autoapi/issues/240>`
The docstrings of `` object.__init__ `` , `` object.__new__ `` ,
`` type.__init__ `` , and `` type.__new__ `` are not inherited.
2021-01-31 18:11:30 +00:00
2021-01-31 23:34:40 +00:00
Bug Fixes
^^^^^^^^^
* `#260 <https://github.com/readthedocs/sphinx-autoapi/issues/260>`
The overload signatures of `` __init__ `` methods are documented.
2021-01-31 18:11:30 +00:00
2021-01-20 23:13:20 +00:00
V1.6.0 (2021-01-20)
-------------------
2020-10-03 19:21:25 +00:00
Breaking Changes
^^^^^^^^^^^^^^^^
* Dropped support for Python 2 and Sphinx 1.x/2.x.
Python 2 source code can still be parsed.
2020-10-05 20:18:35 +00:00
Features
^^^^^^^^
* Added support for using type hints as parameter types and return types
via the `` sphinx.ext.autodoc.typehints `` extension.
2020-10-26 23:12:59 +00:00
* `#191 <https://github.com/readthedocs/sphinx-autoapi/issues/191>`
Basic incremental build support is enabled `` autoapi_keep_files `` is enabled.
2021-01-20 22:59:15 +00:00
Providing none of the source files have changed,
AutoAPI will skip parsing the source code and regenerating the API documentation.
2020-11-14 06:47:10 +00:00
* `#200 <https://github.com/readthedocs/sphinx-autoapi/issues/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.
2021-01-20 22:59:15 +00:00
* Added support for Python 3.9.
2020-10-05 20:18:35 +00:00
2020-10-26 22:33:55 +00:00
Bug Fixes
^^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-10-26 22:33:55 +00:00
* `#246 <https://github.com/readthedocs/sphinx-autoapi/issues/246>`
Fixed TypeError when parsing a class that inherits from `` type `` .
2020-10-26 23:22:26 +00:00
* `#244 <https://github.com/readthedocs/sphinx-autoapi/issues/244>`
Fixed an unnecessary deprecation warning being raised when running
sphinx-build from the same directory as conf.py.
2020-11-14 05:28:47 +00:00
* Fixed properties documented by Autodoc directives geting documented as methods.
2020-10-26 22:33:55 +00:00
2020-10-05 20:18:35 +00:00
2020-10-03 05:03:06 +00:00
V1.5.1 (2020-10-01)
-------------------
Bug Fixes
^^^^^^^^^
2021-01-31 23:34:40 +00:00
2020-10-03 05:03:06 +00:00
* Fixed AttributeError when generating an inheritance diagram for a module.
2020-09-01 04:59:16 +00:00
V1.5.0 (2020-08-31)
2020-10-03 05:03:06 +00:00
-------------------
2020-07-12 02:27:59 +00:00
2020-09-01 04:59:16 +00:00
This will be the last minor version to support Python 2 and Sphinx 1.x/2.x.
2020-07-12 02:53:00 +00:00
Features
^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-07-12 02:53:00 +00:00
* `#222 <https://github.com/readthedocs/sphinx-autoapi/issues/222>`
2020-09-01 04:59:16 +00:00
Declare the extension as parallel unsafe.
* `#217 <https://github.com/readthedocs/sphinx-autoapi/issues/217>`
All overload signatures are documented.
* `#243 <https://github.com/readthedocs/sphinx-autoapi/issues/243>`
Files are found in order of preference according to `` autoapi_file_patterns `` .
* Added support for Sphinx 3.2.
2020-07-12 02:53:00 +00:00
2020-07-12 02:27:59 +00:00
Bug Fixes
^^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-07-12 02:27:59 +00:00
* `#219 <https://github.com/readthedocs/sphinx-autoapi/issues/219>`
Fixed return types not showing for methods.
2020-08-01 06:27:29 +00:00
* Fixed incorrect formatting of properties on generated method directives.
2020-08-01 06:28:44 +00:00
* Fixed every toctree entry getting added as a new list.
2020-09-01 04:59:16 +00:00
* `#234 <https://github.com/readthedocs/sphinx-autoapi/issues/234>`
Fixed only some entries getting added to the toctree.
2020-07-12 02:27:59 +00:00
2020-08-01 08:25:09 +00:00
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-08-01 08:25:09 +00:00
* autoapisummary directive inherits from autosummary for future stability.
2020-07-12 02:27:59 +00:00
2020-06-08 02:15:13 +00:00
v1.4.0 (2020-06-07)
2020-05-15 03:37:18 +00:00
-------------------
Features
^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-05-15 03:37:18 +00:00
* `#197 <https://github.com/readthedocs/sphinx-autoapi/issues/197>`
`` autoapi.__version__ `` and `` autoapi.__version_info__ `` attributes
for accessing version information.
2020-05-16 22:28:43 +00:00
* `#201 <https://github.com/readthedocs/sphinx-autoapi/issues/201>`
Added the `` autoapi_member_order `` option to allow the order that members
are documentated to be configurable.
2020-05-16 23:24:16 +00:00
* `#203 <https://github.com/readthedocs/sphinx-autoapi/issues/203>`
A class without a docstring inherits one from its parent.
A methods without a docstring inherits one from the method that it overrides.
2020-05-17 00:36:52 +00:00
* `#204 <https://github.com/readthedocs/sphinx-autoapi/issues/204>`
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.
2020-05-15 03:37:18 +00:00
Bug Fixes
^^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-05-15 03:40:43 +00:00
* `#198 <https://github.com/readthedocs/sphinx-autoapi/issues/198>`
Documentation describes the required layout for template override directories.
2020-05-17 00:51:09 +00:00
* `#195 <https://github.com/readthedocs/sphinx-autoapi/issues/195>`
Fixed incorrect formatting when `` show-inheritance-diagram ``
and `` private-members `` are turned on.
2020-06-08 01:47:34 +00:00
* `#193 <https://github.com/readthedocs/sphinx-autoapi/issues/193>`
2020-06-18 20:45:42 +00:00
`#208 <https://github.com/readthedocs/sphinx-autoapi/issues/208>`
2020-06-08 01:47:34 +00:00
Inheritance diagrams can follow imports to find classes to document.
2020-06-08 02:15:13 +00:00
* `#213 <https://github.com/readthedocs/sphinx-autoapi/issues/213>`
Fixed module summary never showing.
2020-05-15 03:37:18 +00:00
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-05-16 22:28:43 +00:00
* black shows diffs by default
2020-05-21 02:35:54 +00:00
* `#207 <https://github.com/readthedocs/sphinx-autoapi/issues/207>`
Fixed a typo in the code of the golang tutorial.
2020-05-15 03:37:18 +00:00
2020-06-08 01:47:34 +00:00
2020-04-06 03:26:00 +00:00
v1.3.0 (2020-04-05)
2020-05-15 03:37:18 +00:00
-------------------
2019-10-10 02:53:26 +00:00
2020-04-06 03:03:05 +00:00
Breaking Changes
^^^^^^^^^^^^^^^^
* Dropped support for Python 3.4 and 3.5.
2020-01-03 17:22:57 +00:00
Features
^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-05-15 03:37:18 +00:00
* `#151 <https://github.com/readthedocs/sphinx-autoapi/issues/151>`
Added the `` autoapi_python_use_implicit_namespaces `` option to allow
2020-01-03 17:22:57 +00:00
AutoAPI to search for implicit namespace packages.
2020-01-10 01:16:59 +00:00
* Added support for Sphinx 2.2 and 2.3.
* Added support for Python 3.8.
2020-01-12 01:20:50 +00:00
* `#140 <https://github.com/readthedocs/sphinx-autoapi/issues/140>`
Added the `` autoapi-inheritance-diagram `` directive to create
inheritance diagrams without importing modules.
2020-01-25 22:21:56 +00:00
Enable the `` show-inheritance-diagram `` AutoAPI option to
2020-01-12 01:20:50 +00:00
turn the diagrams on in generated documentation.
2020-01-25 22:21:56 +00:00
* `#183 <https://github.com/readthedocs/sphinx-autoapi/issues/183>`
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.
2020-01-26 01:30:59 +00:00
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
`` show-module-summary `` AutoAPI option.
`` autoapi_include_summaries `` will stop working in the next major version.
2020-04-06 03:03:05 +00:00
* Added support for Sphinx 2.4 and 3.0
2020-01-03 17:22:57 +00:00
2020-01-08 00:23:12 +00:00
Bug Fixes
^^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-01-08 00:23:12 +00:00
* `#186 <https://github.com/readthedocs/sphinx-autoapi/issues/186>`
Fixed an exception when there are too many argument type annotations
in a type comment.
2020-01-08 18:23:34 +00:00
* (Python) args and kwargs type annotations can be read from
the function type comment.
2020-01-08 00:23:12 +00:00
2020-04-06 03:00:18 +00:00
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
2021-01-31 18:11:30 +00:00
2020-04-06 03:00:18 +00:00
* Tests are now included in the sdist.
2020-01-03 17:22:57 +00:00
2020-04-06 03:26:00 +00:00
v1.2.1 (2019-10-09)
2020-05-15 03:37:18 +00:00
-------------------
2020-01-03 17:22:57 +00:00
2019-10-10 02:53:26 +00:00
Bug Fixes
^^^^^^^^^
* (Python) "Invalid desc node" warning no longer raised for autodoc-style
directives.
2020-04-06 03:26:00 +00:00
v1.2.0 (2019-10-05)
2020-05-15 03:37:18 +00:00
-------------------
2019-08-08 06:23:21 +00:00
Features
^^^^^^^^
* (Python) Can read per argument type comments with astroid > 2.2.5.
2019-08-11 06:00:29 +00:00
* (Python) Added autoapidecorator directive with Sphinx >= 2.0.
* (Python) Can use autodoc_docstring_signature with Autodoc-style directives.
2019-10-05 22:47:03 +00:00
* (Python) Added autoapi-skip-member event.
2019-08-26 00:04:30 +00:00
* Made it more clear which file causes an error, when an error occurs.
2019-09-08 00:25:03 +00:00
* Sphinx language domains are now optional dependencies.
2019-08-08 06:23:21 +00:00
Bug Fixes
^^^^^^^^^
* (Python) Forward reference annotations are no longer rendered as strings.
2019-08-11 06:00:29 +00:00
* (Python) autoapifunction directive no longer documents async functions as
2020-02-01 21:04:31 +00:00
a normal function.
2019-08-25 22:53:58 +00:00
* (Python) Fixed unicode decode errors in some Python 3 situations.
2020-04-06 01:50:32 +00:00
* Documentation more accurately describes what configuration accepts
relative paths and where they are relative to.
2019-08-08 06:23:21 +00:00
2019-06-23 20:43:28 +00:00
v1.1.0 (2019-06-23)
-------------------
Features
^^^^^^^^
* (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.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
* Fixed some dead links in the README.
* Fixed lint virtualenv.
2019-04-24 22:04:37 +00:00
v1.0.0 (2019-04-24)
-------------------
2019-04-07 00:56:05 +00:00
Features
2019-04-24 22:04:37 +00:00
^^^^^^^^
2019-04-07 00:56:05 +00:00
2020-05-15 03:37:18 +00:00
* `#100 <https://github.com/readthedocs/sphinx-autoapi/issues/100>`
Added support for documenting C extensions via `` .pyi `` stub files.
2019-04-07 00:56:05 +00:00
* Added support for Sphinx 2.0.
* Toned down the API reference index page.
* (Go) Patterns configured in `` autoapi_ignore `` are passed to godocjson.
2019-04-24 22:04:37 +00:00
* New and improved documentation.
* No longer need to set `` autoapi_add_toctree_entry `` to False when `` autoapi_generate_api_docs `` is False.
2020-05-15 03:37:18 +00:00
* `#139 <https://github.com/readthedocs/sphinx-autoapi/issues/139>`
Added support for basic type annotations in documentation generation and autodoc-style directives.
2019-04-07 00:56:05 +00:00
Bug Fixes
2019-04-24 22:04:37 +00:00
^^^^^^^^^
2019-04-07 00:56:05 +00:00
2020-05-15 03:37:18 +00:00
* `#159 <https://github.com/readthedocs/sphinx-autoapi/issues/159>`
Fixed `` UnicodeDecodeError `` on Python 2 when a documenting an attribute that contains binary data.
2019-04-07 00:56:05 +00:00
* (Python) Fixed private submodules displaying when `` private-members `` is turned off.
* Templates no longer produce excessive whitespace.
2019-04-24 22:04:37 +00:00
* (Python) Fixed an error when giving an invalid object to an autodoc-style directive.
2019-04-07 00:56:05 +00:00
Trivial/Internal Changes
2019-04-24 22:04:37 +00:00
^^^^^^^^^^^^^^^^^^^^^^^^
2019-04-07 00:56:05 +00:00
* No longer pin the version of black.
* Added missing test environments to travis.
v0.7.1 (2019-02-04)
-------------------
Bug Fixes
2019-04-24 22:04:37 +00:00
^^^^^^^^^
2019-04-07 00:56:05 +00:00
* (Python) Fixed a false warning when importing a local module.
v0.7.0 (2019-01-30)
-------------------
Breaking Changes
2019-04-24 22:04:37 +00:00
^^^^^^^^^^^^^^^^
2019-04-07 00:56:05 +00:00
* Dropped support for Sphinx<1.6.
Features
2019-04-24 22:04:37 +00:00
^^^^^^^^
2019-04-07 00:56:05 +00:00
* Added debug messages about what AutoAPI is doing.
Bug Fixes
2019-04-24 22:04:37 +00:00
^^^^^^^^^
2019-04-07 00:56:05 +00:00
2020-01-03 20:12:04 +00:00
* `#156 <https://github.com/readthedocs/sphinx-autoapi/issues/156>`
2019-04-07 00:56:05 +00:00
Also capable of giving more detailed warnings.
Trivial/Internal Changes
2019-04-24 22:04:37 +00:00
^^^^^^^^^^^^^^^^^^^^^^^^
2019-04-07 00:56:05 +00:00
* 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)
-------------------
Bug Fixes
2019-04-24 22:04:37 +00:00
^^^^^^^^^
2019-04-07 00:56:05 +00:00
* (Python) Fixed some import chains failing to resolve depending on resolution order.
v0.6.1 (2018-11-14)
-------------------
Bug Fixes
2019-04-24 22:04:37 +00:00
^^^^^^^^^
2019-04-07 00:56:05 +00:00
* (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
2019-04-24 22:04:37 +00:00
^^^^^^^^^^^^^^^^^^^^^^^^
2019-04-07 00:56:05 +00:00
* (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)
-------------------
Breaking Changes
2019-04-24 22:04:37 +00:00
^^^^^^^^^^^^^^^^
2019-04-07 00:56:05 +00:00
2020-01-03 20:12:04 +00:00
* `#152 <https://github.com/readthedocs/sphinx-autoapi/issues/152>` `` autoapi_add_api_root_toctree `` option.
2019-04-07 00:56:05 +00:00
This has been replaced with the `` autoapi_add_toctree_entry `` option.
2020-01-03 20:12:04 +00:00
* `#25 <https://github.com/readthedocs/sphinx-autoapi/issues/25>`
2019-04-07 00:56:05 +00:00
* Removed redundant `` package_dir `` and `` package_data `` options.
Features
2019-04-24 22:04:37 +00:00
^^^^^^^^
2019-04-07 00:56:05 +00:00
* (Python) Added viewcode support for imported members.
2020-01-03 20:12:04 +00:00
* `#146 <https://github.com/readthedocs/sphinx-autoapi/issues/146>`: (Python) No longer documents ``__ init__()`` attributes without a docstring.
* `#153 <https://github.com/readthedocs/sphinx-autoapi/issues/153>`
* `#111 <https://github.com/readthedocs/sphinx-autoapi/issues/111>`
* `#152 <https://github.com/readthedocs/sphinx-autoapi/issues/152>`
2019-04-07 00:56:05 +00:00
Also removed autoapi_add_api_root_toctree config option
2020-01-03 20:12:04 +00:00
* `#150 <https://github.com/readthedocs/sphinx-autoapi/issues/150>` `` private-members `` also controls private subpackages and submodules.
2019-04-07 00:56:05 +00:00
* (Python) Added support for static and class methods.
* (Python) Methods include `` self `` in their arguments.
This more closely matches autodoc behaviour.
2020-01-03 20:12:04 +00:00
* `#145 <https://github.com/readthedocs/sphinx-autoapi/issues/145>`
2019-04-07 00:56:05 +00:00
* (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
2019-04-24 22:04:37 +00:00
^^^^^^^^^
2019-04-07 00:56:05 +00:00
* (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.
2020-01-03 20:12:04 +00:00
* `#148 <https://github.com/readthedocs/sphinx-autoapi/issues/148>`
2019-04-07 00:56:05 +00:00
* (Python) Fixed filtered classes and attributes getting displayed.
* (Python) Fixed incorrect display of long lists.
2020-01-03 20:12:04 +00:00
* `#125 <https://github.com/readthedocs/sphinx-autoapi/issues/125>`
* `#125 <https://github.com/readthedocs/sphinx-autoapi/issues/125>` `` autoapi_dirs `` .
2019-04-07 00:56:05 +00:00
Trivial/Internal Changes
2019-04-24 22:04:37 +00:00
^^^^^^^^^^^^^^^^^^^^^^^^
2019-04-07 00:56:05 +00:00
* Added Sphinx 1.7 and 1.8.0b1 testing.
2020-01-03 20:12:04 +00:00
* `#120 <https://github.com/readthedocs/sphinx-autoapi/issues/120>`
2019-04-07 00:56:05 +00:00
* Removed old testing dependencies.
2020-01-03 20:12:04 +00:00
* `#143 <https://github.com/readthedocs/sphinx-autoapi/issues/143>`
