Path to this page:
./
textproc/py-sphinx-autoapi,
Autodoc style documentation for multiple languages
Branch: CURRENT,
Version: 3.3.3,
Package name: py312-sphinx-autoapi-3.3.3,
Maintainer: minskimSphinx AutoAPI provides "autodoc" style documentation for multiple
programming languages without needing to load, run, or import the
project being documented.
Required to run:[
textproc/py-yaml] [
textproc/py-sphinx] [
textproc/py-jinja2] [
textproc/py-Unidecode] [
devel/py-astroid] [
lang/python310]
Master sites:
Filesize: 28.379 KB
Version history: (Expand)
- (2024-11-01) Updated to version: py312-sphinx-autoapi-3.3.3
- (2024-10-19) Updated to version: py312-sphinx-autoapi-3.3.2
- (2024-09-13) Updated to version: py312-sphinx-autoapi-3.3.1
- (2024-07-29) Updated to version: py311-sphinx-autoapi-3.2.1
- (2024-07-21) Updated to version: py311-sphinx-autoapi-3.2.0
- (2024-06-26) Updated to version: py311-sphinx-autoapi-3.1.2
CVS history: (Expand)
2023-11-07 23:38:10 by Thomas Klausner | Files touched by this commit (112) |
Log message:
*: latest py-sphinx only support Python 3.9+
|
2023-10-14 10:01:49 by Thomas Klausner | Files touched by this commit (3) | |
Log message:
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
|
2023-06-18 14:37:22 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
py-sphinx-autoapi: updated to 2.1.1
v2.1.1 (2023-06-10)
-------------------
Bugfixes
- Fix "document isn't included" warning when using \
autoapi_add_toctree_entry
- Types used in PEP-604 union syntax can be linked with intersphinx
- Fix class overrides not rendering correctly.
- Fix separated type comments for arguments not merging correctly in Python 3.7
- Fixed viewcode being unable to find the source code for imported objects
Improved Documentation
- Made it clearer how to customise what objects AutoAPI will document.
|
2023-05-06 10:39:03 by Thomas Klausner | Files touched by this commit (3) | |
Log message:
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.
|
2022-01-04 21:55:40 by Thomas Klausner | Files touched by this commit (1595) |
Log message:
*: bump PKGREVISION for egg.mk users
They now have a tool dependency on py-setuptools instead of a DEPENDS
|
2021-10-26 13:23:42 by Nia Alarie | Files touched by this commit (1161) |
Log message:
textproc: Replace RMD160 checksums with BLAKE2s checksums
All checksums have been double-checked against existing RMD160 and
SHA512 hashes
Unfetchable distfiles (fetched conditionally?):
./textproc/convertlit/distinfo clit18src.zip
|
2021-10-11 11:31:22 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
py-sphinx-autoapi: updated to 1.8.4
v1.8.4
Fixed compatibility with astroid 2.7+.
|
2021-10-07 17:02:49 by Nia Alarie | Files touched by this commit (1162) |
Log message:
textproc: Remove SHA1 hashes for distfiles
|