./textproc/py-sphinx-autodoc-typehints, Type hints support for the Sphinx autodoc extension

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


Branch: CURRENT, Version: 1.12.0, Package name: py38-sphinx-autodoc-typehints-1.12.0, Maintainer: minskim

This extension allows you to use Python 3 annotations for documenting
acceptable argument types and return value types of functions. This
allows you to use type hints in a very natural fashion.


Required to run:
[devel/py-setuptools] [textproc/py-sphinx] [lang/python37] [devel/py-typing-extensions]

Required to build:
[pkgtools/cwrappers] [devel/py-setuptools_scm]

Master sites:

SHA1: 64ab64fb0b90a823e03af3266a72e7fb52cf07d7
RMD160: ed1fb33fe6786ae54afbcae751c2fc76a3a21309
Filesize: 19.037 KB

Version history: (Expand)


CVS history: (Expand)


   2021-04-16 08:05:43 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx-autodoc-typehints: updated to 1.12.0

1.12.0
- Dropped Python 3.5 support
- Added the simplify_optional_unions config option
- Fixed indentation of multiline strings
   2021-04-07 08:48:26 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-sphinx-autodoc-typehints: updated to 1.11.1

1.11.1
======
* Changed formatting of ``None`` to point to the Python stdlib docs
* Updated special dataclass handling

1.11.0
======
* Dropped support for Sphinx < 3.0
* Added support for alternative parameter names (``arg``, ``argument``, \ 
``parameter``)
* Fixed import path for Signature
* Fixed ``TypeError`` when formatting a parametrized ``typing.IO`` annotat
   2020-04-06 10:06:30 by Thomas Klausner | Files touched by this commit (3) | Package updated
Log message:
py-sphinx-autodoc-typehints: update to 1.10.3.

1.10.3
======

* Fixed ``TypeError`` (or wrong rendered class name) when an annotation is a \ 
generic class that has
  a ``name`` property

1.10.2
======

* Fixed inner classes missing their parent class name(s) when rendered

1.10.1
======

* Fixed ``KeyError`` when encountering mocked annotations (``autodoc_mock_imports``)

1.10.0
======

* Rewrote the annotation formatting logic (fixes Python 3.5.2 compatibility \ 
regressions and an
  ``AttributeError`` regression introduced in v1.9.0)
* Fixed decorator classes not being processed as classes

1.9.0
=====

* Added support for typing_extensions_
* Added the ``typehints_document_rtype`` option (PR by Simon-Martin Schröder)
* Fixed metaclasses as annotations causing ``TypeError``
* Fixed rendering of ``typing.Literal``
* Fixed OSError when generating docs for SQLAlchemy mapped classes
* Fixed unparametrized generic classes being rendered with their type parameters
  (e.g. ``Dict[~KT, ~VT]``)

.. _typing_extensions: https://pypi.org/project/typing-extensions/

1.8.0
=====

* Fixed regression which caused ``TypeError`` or ``OSError`` when trying to set \ 
annotations due to
  PR #87
* Fixed unintentional mangling of annotation type names
* Added proper ``:py:data`` targets for ``NoReturn``, ``ClassVar`` and ``Tuple``
* Added support for inline type comments (like ``(int, str) -> None``) (PR by \ 
Bernát Gábor)
* Use the native AST parser for type comment support on Python 3.8+

1.7.0
=====

* Dropped support for Python 3.4
* Fixed unwrapped local functions causing errors (PR by Kimiyuki Onaka)
* Fixed ``AttributeError`` when documenting the ``__init__()`` method of a data class
* Added support for type hint comments (PR by Markus Unterwaditzer)
* Added flag for rendering classes with their fully qualified names (PR by Holly \ 
Becker)

1.6.0
=====

* Fixed ``TypeError`` when formatting annotations from a class that inherits \ 
from a concrete
  generic type (report and tests by bpeake-illuscio)
* Added support for ``typing_extensions.Protocol`` (PR by Ian Good)
* Added support for ``typing.NewType`` (PR by George Leslie-Waksman)

1.5.2
=====

* Emit a warning instead of crashing when an unresolvable forward reference is \ 
encountered in type
  annotations

1.5.1
=====

* Fixed escape characters in parameter default values getting lost during \ 
signature processing
* Replaced use of the ``config-inited`` event (which inadvertently required \ 
Sphinx 1.8) with the
  ``builder-inited`` event

1.5.0
=====

* The setting of the ``typing.TYPECHECKING`` flag is now configurable using the
  ``set_type_checking_flag`` option

1.4.0
=====

* The extension now sets ``typing.TYPECHECKING`` to ``True`` during setup to \ 
include conditional
  imports which may be used in type annotations
* Fixed parameters with trailing underscores (PR by Daniel Knell)
* Fixed KeyError with private methods (PR by Benito Palacios Sánchez)
* Fixed deprecation warning about the use of formatargspec (PR by Y. Somda)
* The minimum Sphinx version is now v1.7.0

1.3.1
=====

* Fixed rendering of generic types outside the typing module (thanks to Tim \ 
Poterba for the PR)
   2019-05-02 11:27:09 by Adam Ciarcinski | Files touched by this commit (5)
Log message:
Forget about Python 3.4
   2018-09-28 00:38:59 by Tobias Nygren | Files touched by this commit (1)
Log message:
py-sphinx-autodoc-typehints: BUILD_DEPENDS on py-setuptools_scm
   2018-05-27 03:59:36 by Min Sik Kim | Files touched by this commit (5)
Log message:
textproc/py-sphinx-autodoc-typehints: Import version 1.3.0

This extension allows you to use Python 3 annotations for documenting
acceptable argument types and return value types of functions. This
allows you to use type hints in a very natural fashion.