Versions follow Semantic Versioning (<major>.<minor>.<patch>).
- #197 <#197>: Added
autoapi.__version__andautoapi.__version_info__attributes for accessing version information.
- #198 <#198>: Documentation describes the required layout for template override directories.
- Dropped support for Python 3.4 and 3.5.
- #151 <#151>: (Python)
Added the
autoapi_python_use_implicit_namespacesoption 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 <#140>: (Python)
Added the
autoapi-inheritance-diagramdirective to create inheritance diagrams without importing modules. Enable theshow-inheritance-diagramAutoAPI option to turn the diagrams on in generated documentation. - #183 <#183>: (Python)
Added the
show-inheritanceAutoAPI option to be able to enable or disable the display of a list of base classes in generated documentation about a class. Added theinherited-membersAutoAPI 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_summariesoption has been replaced with theshow-module-summaryAutoAPI option.autoapi_include_summarieswill stop working in the next major version. - Added support for Sphinx 2.4 and 3.0
- #186 <#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 the function type comment.
- Tests are now included in the sdist.
- (Python) "Invalid desc node" warning no longer raised for autodoc-style directives.
- (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) 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 relative paths and where they are relative to.
- (Python) Can override ignoring local imports in modules by using __all__.
- (Python) Fixed incorrect formatting of functions and methods.
- Added support for Sphinx 2.1.
- Fixed some dead links in the README.
- Fixed lint virtualenv.
- #100 <#100>: (Python)
Added support for documenting C extensions via
.pyistub files. - Added support for Sphinx 2.0.
- Toned down the API reference index page.
- (Go) Patterns configured in
autoapi_ignoreare passed to godocjson. - New and improved documentation.
- No longer need to set
autoapi_add_toctree_entryto False whenautoapi_generate_api_docsis False. - #139 <#139> Added support for basic type annotations in documentation generation and autodoc-style directives.
- #159 <#159>: (Python)
Fixed
UnicodeDecodeErroron Python 2 when a documenting an attribute that contains binary data. - (Python) Fixed private submodules displaying when
private-membersis turned off. - Templates no longer produce excessive whitespace.
- (Python) Fixed an error when giving an invalid object to an autodoc-style directive.
- No longer pin the version of black.
- Added missing test environments to travis.
- (Python) Fixed a false warning when importing a local module.
- Dropped support for Sphinx<1.6.
- Added debug messages about what AutoAPI is doing.
#156 <#156>: (Python) Made import resolution more stable.
Also capable of giving more detailed warnings.
- 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.
- (Python) Fixed some import chains failing to resolve depending on resolution order.
- (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) Added Python 3.7 testing.
- Started testing against stable version of Sphinx 1.8.
- Fixed all "no title" warnings during tests.
#152 <#152>: Removed the
autoapi_add_api_root_toctreeoption.This has been replaced with the
autoapi_add_toctree_entryoption.#25 <#25>: Removed distutils support.
Removed redundant
package_dirandpackage_dataoptions.
(Python) Added viewcode support for imported members.
#146 <#146>: (Python) No longer documents
__init__()attributes without a docstring.#153 <#153>: (Python) Can document a public python API.
#111 <#111>: (Python) Can opt to write manual documentation through new autodoc-style directives.
#152 <#152>: Made it easier to remove default index page.
Also removed autoapi_add_api_root_toctree config option
#150 <#150>: (Python)
private-membersalso controls private subpackages and submodules.(Python) Added support for static and class methods.
(Python) Methods include
selfin their arguments.This more closely matches autodoc behaviour.
#145 <#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.
- (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 <#148>: (Python) Fixed astroid 2.0 compatibility.
- (Python) Fixed filtered classes and attributes getting displayed.
- (Python) Fixed incorrect display of long lists.
- #125 <#125>: (Javacript) Fixed running incorrect jsdoc command on Windows.
- #125 <#125>: (Python) Support specifying package directories in
autoapi_dirs.