Up to [cvs.NetBSD.org] / pkgsrc / textproc / py-sphinx-autoapi
Request diff between arbitrary revisions
Keyword substitution: kv
Default branch: MAIN
py-sphinx-autoapi: adapt for flit_core 3.11. Bump PKGREVISION.
py-sphinx-autoapi: updated to 3.5.0 3.5.0 Features Can exclude directories from being documented Bugfixes Fix exception when calling a function imported from a wildcard Remove usage of astroid alpha builds Misc Fix formatting failure in tests
py-sphinx-autoapi: update to 3.3.3.
v3.3.3 (2024-10-25)
Bugfixes
Document packages and modules under a single "submodules" heading (#450)
Fix crash when __init__ is assigned to (#488)
Fix documenting incorrect attributes from __init__ (#497)
py-sphinx-autoapi: update to 3.1.1. v3.1.1 (2024-05-22) ------------------- Bugfixes ^^^^^^^^ - Fix private subpackages causing orphan pages (#446) v3.1.0 (2024-05-20) ------------------- Features ^^^^^^^^ - Objects can render to their own page (#226) - Render PEP-695 type aliases as TypeAlias assignments. (#414) Bugfixes ^^^^^^^^ - Values are always rendered for TypeAlises and PEP-695 type aliases. (#224) - Fix submodule with `__init__.pyi` documented as `__init__` instead of submodule name (#398) - Fix IndexError when a module docstring contains only a heading (#412) - Preserve strings inside Literal type annotations (#423) - Stopped using xrefs in page titles (#427) - Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (#445) - Fix emitting ignore event twice for methods. Misc ^^^^ - #388
py-sphinx-autoapi: update to 3.0.0. v3.0.0 (2023-09-26) ------------------- Bugfixes ^^^^^^^^ - Ensure `tooltip` is always a `str`. (str-tooltip) - Replaced usage of deprecated sphinx.util.status_iterator (#391) Deprecations and Removals ^^^^^^^^^^^^^^^^^^^^^^^^^ - Removed support for documenting languages other than Python (#248) - Removed support for Python 3.7
py-sphinx-autoapi: update to 2.1.0. 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 https://github.com/sphinx-doc/sphinx/issues/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.
py-sphinx-autoapi: updated to 1.8.0 v1.8.0 (2021-04-12) ------------------- Features * Expandable value for multi-line string attributes. * Can resolve the qualified paths of parameters to generics. * Warnings have been categorised and can be suppressed through ``suppress_warnings``. * Data attributes are documentated in module summaries. Bug Fixes * 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. * Fixed data annotations causing pickle or deepcopy errors. * Documentation can be generated when multiple source directories share a single ``conf.py`` file. Trivial/Internal Changes * 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. * 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.
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.
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.