./textproc/py-sphinx-autoapi, Autodoc style documenation for multiple languages

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]


Branch: CURRENT, Version: 1.8.1, Package name: py38-sphinx-autoapi-1.8.1, Maintainer: minskim

Sphinx 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] [devel/py-setuptools] [textproc/py-sphinx] [textproc/py-jinja2] [textproc/py-Unidecode] [devel/py-astroid] [lang/python37]

Required to build:
[pkgtools/cwrappers]

Master sites:

SHA1: 0c4711bc25cb54574622ae7e5ce4ec4bc4041a76
RMD160: 638f94126a0490659bf7b051a8d7a0875776e333
Filesize: 41163.69 KB

Version history: (Expand)


CVS history: (Expand)


   2021-04-28 14:44:52 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx-autoapi: updated to 1.8.1

v1.8.1 (2021-04-24)
-------------------
Bug Fixes
* Fixed type annotations being shown for only a single module.
   2021-04-16 08:02:44 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
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.
   2021-04-07 08:44:39 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
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) | Package updated
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.