Versions follow Semantic Versioning (<major>.<minor>.<patch>).
- #273 <readthedocs#273>: Fixed type annotations being shown for only a single module.
- Expandable value for multi-line string attributes.
- #265 <readthedocs#265>: Can resolve the qualified paths of parameters to generics.
- #275 <readthedocs#275>:
Warnings have been categorised and can be suppressed through
suppress_warnings. - #280 <readthedocs#280>: Data attributes are documentated in module summaries.
- #273 <readthedocs#273>:
Fixed setting
autodoc_typehintstononeordescriptionnot turning off signature type hints.autodoc_typehintsintegration is consisidered experimental until the extension properly supports overload functions. - #261 <readthedocs#261>: Fixed data annotations causing pickle or deepcopy errors.
- Documentation can be generated when multiple source directories
share a single
conf.pyfile.
- Fixed
DeprecationWarningfor invalid escape sequence\sin tests. - Fixed
FutureWarningforNode.traverse()becoming an iterator instead of list. - New example implementation of
autoapi-skip-memberSphinx 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.
- 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 <readthedocs#240>:
The docstrings of
object.__init__,object.__new__,type.__init__, andtype.__new__are not inherited.
- #260 <readthedocs#260>:
The overload signatures of
__init__methods are documented.
- Dropped support for Python 2 and Sphinx 1.x/2.x. Python 2 source code can still be parsed.
- Added support for using type hints as parameter types and return types
via the
sphinx.ext.autodoc.typehintsextension. - #191 <readthedocs#191>:
Basic incremental build support is enabled
autoapi_keep_filesis enabled. Providing none of the source files have changed, AutoAPI will skip parsing the source code and regenerating the API documentation. - #200 <readthedocs#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.
- #246 <readthedocs#246>:
Fixed TypeError when parsing a class that inherits from
type. - #244 <readthedocs#244>: Fixed an unnecessary deprecation warning being raised when running sphinx-build from the same directory as conf.py.
- Fixed properties documented by Autodoc directives geting documented as methods.
- Fixed AttributeError when generating an inheritance diagram for a module.
This will be the last minor version to support Python 2 and Sphinx 1.x/2.x.
- #222 <readthedocs#222>: Declare the extension as parallel unsafe.
- #217 <readthedocs#217>: All overload signatures are documented.
- #243 <readthedocs#243>:
Files are found in order of preference according to
autoapi_file_patterns. - Added support for Sphinx 3.2.
- #219 <readthedocs#219>: Fixed return types not showing for methods.
- Fixed incorrect formatting of properties on generated method directives.
- Fixed every toctree entry getting added as a new list.
- #234 <readthedocs#234>: Fixed only some entries getting added to the toctree.
- autoapisummary directive inherits from autosummary for future stability.
- #197 <readthedocs#197>: Added
autoapi.__version__andautoapi.__version_info__attributes for accessing version information. - #201 <readthedocs#201>: (Python)
Added the
autoapi_member_orderoption to allow the order that members are documentated to be configurable. - #203 <readthedocs#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 <readthedocs#204>: (Python)
Added the
imported-membersAutoAPI option to be able to enable or disable documenting objects imported from the same top-level package or module without needing to override templates.
- #198 <readthedocs#198>: Documentation describes the required layout for template override directories.
- #195 <readthedocs#195>: (Python)
Fixed incorrect formatting when
show-inheritance-diagramandprivate-membersare turned on. - #193 <readthedocs#193> and #208 <readthedocs#208>: (Python) Inheritance diagrams can follow imports to find classes to document.
- #213 <readthedocs#213>: (Python) Fixed module summary never showing.
- black shows diffs by default
- #207 <readthedocs#207>: Fixed a typo in the code of the golang tutorial.
- Dropped support for Python 3.4 and 3.5.
- #151 <readthedocs#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 <readthedocs#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 <readthedocs#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 <readthedocs#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 <readthedocs#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 <readthedocs#139> Added support for basic type annotations in documentation generation and autodoc-style directives.
- #159 <readthedocs#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 <readthedocs#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 <readthedocs#152>: Removed the
autoapi_add_api_root_toctreeoption.This has been replaced with the
autoapi_add_toctree_entryoption.#25 <readthedocs#25>: Removed distutils support.
Removed redundant
package_dirandpackage_dataoptions.
(Python) Added viewcode support for imported members.
#146 <readthedocs#146>: (Python) No longer documents
__init__()attributes without a docstring.#153 <readthedocs#153>: (Python) Can document a public python API.
#111 <readthedocs#111>: (Python) Can opt to write manual documentation through new autodoc-style directives.
#152 <readthedocs#152>: Made it easier to remove default index page.
Also removed autoapi_add_api_root_toctree config option
#150 <readthedocs#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 <readthedocs#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 <readthedocs#148>: (Python) Fixed astroid 2.0 compatibility.
- (Python) Fixed filtered classes and attributes getting displayed.
- (Python) Fixed incorrect display of long lists.
- #125 <readthedocs#125>: (Javacript) Fixed running incorrect jsdoc command on Windows.
- #125 <readthedocs#125>: (Python) Support specifying package directories in
autoapi_dirs.
- Added Sphinx 1.7 and 1.8.0b1 testing.
- #120 <readthedocs#120>: Updated documentation to remove outdated references.
- Removed old testing dependencies.
- #143 <readthedocs#143>: Removed unnecessary wheel dependency.