Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
v2.1.0 (2023-03-28) ------------------- Deprecations and Removals ^^^^^^^^^^^^^^^^^^^^^^^^^ - Support for documenting languages other than Python is deprecated. (#248) - Removed the option to have autoapi generate toctree entries for domain objects. Domain objects are now added to the toctree by Sphinx. Dropped support for sphinx < 5.2.0. (#369) Misc ^^^^ - Added basic type checking. - Integrated towncrier into the release workflow. 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. Bug Fixes ^^^^^^^^^ - `#330 <https://github.com/readthedocs/sphinx-autoapi/issues/330>`: (Python) Render tuple values as tuples, not lists. - `#341 <https://github.com/readthedocs/sphinx-autoapi/issues/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. Trivial/Internal Changes ^^^^^^^^^^^^^^^^^^^^^^^^ - Removed some autogenerated test data from the repository. v2.0.0 (2022-09-27) ------------------- Breaking Changes ^^^^^^^^^^^^^^^^ - Dropped support for Sphinx <4. - `#352 <https://github.com/readthedocs/sphinx-autoapi/issues/352>`: (Python) Properties are rendered with the ``property`` directive, fixing support for Sphinx 5.2. A new ``PythonPythonMapper`` object (``PythonProperty``) has been created to support this change. This object can be passed to templates, filters, and hooks. A new ``property.rst`` template has also been created to support this change. Trivial/Internal Changes ^^^^^^^^^^^^^^^^^^^^^^^^ - Use https links where possible in documentation. - Pass correct argument types to ``status_iterator``. V1.9.0 (2022-07-25) ------------------- Breaking Changes ^^^^^^^^^^^^^^^^ - Dropped support for Python 3.6. Features ^^^^^^^^ - Added support for Python 3.10. - `#222 <https://github.com/readthedocs/sphinx-autoapi/issues/222>`: Marked extension as parallel read safe. Bug Fixes ^^^^^^^^^ - `#324 <https://github.com/readthedocs/sphinx-autoapi/issues/324>`: (Python) Fail elegantly when no source files are found. - (Python) Stop calling ``autodoc-process-docstring`` when docstring is empty. Works around sphinx-doc/sphinx#10701. - `#318 <https://github.com/readthedocs/sphinx-autoapi/issues/318>`: (Python) Fixed misaligned argument types on methods/classmethods when using type comments. - `#278 <https://github.com/readthedocs/sphinx-autoapi/issues/278>`: (Python) Limit signatures to 60 characters in summaries. - Fix keyerror when using markdown sources. - `#328 <https://github.com/readthedocs/sphinx-autoapi/issues/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.
- Loading branch information