2021-04-07 08:44:39 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message: py-sphinx-autoapi: updated to 1.7.0 V1.7.0 (2021-01-31) ------------------- Features * 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. * The docstrings of ``object.__init__``, ``object.__new__``, ``type.__init__``, and ``type.__new__`` are not inherited. Bug Fixes * The overload signatures of ``__init__`` methods are documented. V1.6.0 (2021-01-20) ------------------- Breaking Changes * Dropped support for Python 2 and Sphinx 1.x/2.x. Python 2 source code can still be parsed. Features * Added support for using type hints as parameter types and return types via the ``sphinx.ext.autodoc.typehints`` extension. * 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. * 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. Bug Fixes * Fixed TypeError when parsing a class that inherits from ``type``. * 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. V1.5.1 (2020-10-01) ------------------- Bug Fixes * Fixed AttributeError when generating an inheritance diagram for a module. V1.5.0 (2020-08-31) ------------------- This will be the last minor version to support Python 2 and Sphinx 1.x/2.x. Features * Declare the extension as parallel unsafe. * All overload signatures are documented. * Files are found in order of preference according to ``autoapi_file_patterns``. * Added support for Sphinx 3.2. Bug Fixes * 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. * Fixed only some entries getting added to the toctree. Trivial/Internal Changes * autoapisummary directive inherits from autosummary for future stability. |
2020-08-24 10:42:38 by Thomas Klausner | Files touched by this commit (3) | |
Log message: py-sphinx-autoapi: update to 1.4.0. v1.4.0 (2020-06-07) ------------------- Features ^^^^^^^^ * `#197 <https://github.com/readthedocs/sphinx-autoapi/issues/197>`: Added ``autoapi.__version__`` and ``autoapi.__version_info__`` attributes for accessing version information. * `#201 <https://github.com/readthedocs/sphinx-autoapi/issues/201>`: (Python) Added the ``autoapi_member_order`` option to allow the order that members are documentated to be configurable. * `#203 <https://github.com/readthedocs/sphinx-autoapi/issues/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 <https://github.com/readthedocs/sphinx-autoapi/issues/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. Bug Fixes ^^^^^^^^^ * `#198 <https://github.com/readthedocs/sphinx-autoapi/issues/198>`: Documentation describes the required layout for template override directories. * `#195 <https://github.com/readthedocs/sphinx-autoapi/issues/195>`: (Python) Fixed incorrect formatting when ``show-inheritance-diagram`` and ``private-members`` are turned on. * `#193 <https://github.com/readthedocs/sphinx-autoapi/issues/193>` and * `#208 <https://github.com/readthedocs/sphinx-autoapi/issues/208>`: (Python) Inheritance diagrams can follow imports to find classes to document. * `#213 <https://github.com/readthedocs/sphinx-autoapi/issues/213>`: (Python) Fixed module summary never showing. Trivial/Internal Changes ^^^^^^^^^^^^^^^^^^^^^^^^ * black shows diffs by default * `#207 <https://github.com/readthedocs/sphinx-autoapi/issues/207>`: Fixed a typo in the code of the golang tutorial. |
2020-04-06 09:38:39 by Thomas Klausner | Files touched by this commit (4) |
Log message: textproc/py-sphinx-autoapi: import py-sphinx-autoapi-1.3.0 Sphinx AutoAPI provides "autodoc" style documentation for multiple programming languages without needing to load, run, or import the project being documented. |