* Allow Sphinx explicitly to write in parallel.
* Fixed crash when documenting ParamSpecArgs
* Fixed a bug where if a class has an attribute and a constructor
argument with the same name, the constructor argument
type would be rendered incorrectly (issue 308)
* Fixed napoleon handling of numpy docstrings with no specified
return type.
* Fix a `Field list ends without a blank line` warning (issue 305).
* More robust determination of rtype location / fix issue 302
* Improvements to the location of the return type
* Use format_annotation to render class attribute type annotations
* Fix overloads support
* Fix spacing between `:rtype:` and directives
* Handle types from types module
* If module is \_io, use io instead
* Put rtype before examples or usage section
* Remove redundant return type for attributes
* Handle collections.abc.Callable as well as typing.Callable
* Put Literal args in code blocks
* Fix Optional role to be data.
* Fixed default options not displaying for parameters without
type hints.
* Use hatchling instead of setuptools
* Add support for typing.ParamSpec
* Allow star prefixes for parameter names in docstring
- Update to version 1.19.2
python-sphinx-autodoc-typehints-system-object.inv.patch
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-sphinx-autodoc-typehints?expand=0&rev=43
- Switch to multibuild to break build cycles.
- Upgrade to 1.18.1:
- Fix mocked module import not working when used as guarded
import
- Support and require nptyping>=2
- Handle UnionType
- Mark it as requiring nptyping<2
- Add typehints_use_rtype option
- Handles TypeError when getting source code via inspect
- Add support for type subscriptions with multiple elements,
where one or more elements are tuples; e.g.,
nptyping.NDArray[(Any, ...), nptyping.Float]
- Fix bug for arbitrary types accepting singleton
subscriptions; e.g., nptyping.Float[64]
- Resolve forward references
- Expand and better handle TypeVar
- Add intershpinx reference link for ... to Ellipsis (as is
just an alias)
- Prevents reaching inner blocks that contains if TYPE_CHECKING
- Log a warning instead of crashing when a type guard import
fails to resolve
- When resolving type guard imports if the target module does
not have source code (such is the case for C-extension
modules) do nothing instead of crashing
- Fix fully_qualified should be typehints_fully_qualified
- Resolve type guard imports before evaluating annotations for
objects
- Remove set_type_checking_flag flag as this is now done by
default
- Fix crash when the inspect module returns an invalid python
syntax source
- Made formatting function configurable using the option
typehints_formatter
- Fixed normalize_source_lines() messing with the indentation
of methods with decorators that have parameters starting with
def.
- Handle ValueError or TypeError being raised when signature of
an object cannot be determined
- Fix KeyError being thrown when argument is not documented
(e.g. cls argument for class methods, and self for methods)
- Added typehints_defaults config option allowing to
automatically annotate parameter defaults.
- Fixed NewType inserts a reference as first argument instead
of a string
- Dropped Python 3.6 support
- Python 3.10 support
- Normalize async functions properly
- Allow py310 style annotations (PEP-563)
OBS-URL: https://build.opensuse.org/request/show/976276
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-sphinx-autodoc-typehints?expand=0&rev=10
- Upgrade to 1.18.1:
- Fix mocked module import not working when used as guarded
import
- Support and require nptyping>=2
- Handle UnionType
- Mark it as requiring nptyping<2
- Add typehints_use_rtype option
- Handles TypeError when getting source code via inspect
- Add support for type subscriptions with multiple elements,
where one or more elements are tuples; e.g.,
nptyping.NDArray[(Any, ...), nptyping.Float]
- Fix bug for arbitrary types accepting singleton
subscriptions; e.g., nptyping.Float[64]
- Resolve forward references
- Expand and better handle TypeVar
- Add intershpinx reference link for ... to Ellipsis (as is
just an alias)
- Prevents reaching inner blocks that contains if TYPE_CHECKING
- Log a warning instead of crashing when a type guard import
fails to resolve
- When resolving type guard imports if the target module does
not have source code (such is the case for C-extension
modules) do nothing instead of crashing
- Fix fully_qualified should be typehints_fully_qualified
- Resolve type guard imports before evaluating annotations for
objects
- Remove set_type_checking_flag flag as this is now done by
default
- Fix crash when the inspect module returns an invalid python
syntax source
- Made formatting function configurable using the option
typehints_formatter
- Fixed normalize_source_lines() messing with the indentation
of methods with decorators that have parameters starting with
def.
- Handle ValueError or TypeError being raised when signature of
an object cannot be determined
- Fix KeyError being thrown when argument is not documented
(e.g. cls argument for class methods, and self for methods)
- Added typehints_defaults config option allowing to
automatically annotate parameter defaults.
- Fixed NewType inserts a reference as first argument instead
of a string
- Dropped Python 3.6 support
- Python 3.10 support
- Normalize async functions properly
- Allow py310 style annotations (PEP-563)
OBS-URL: https://build.opensuse.org/request/show/975167
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-sphinx-autodoc-typehints?expand=0&rev=25
- Add no-net-tests.patch which marks tests requiring network
(gh#agronholm/sphinx-autodoc-typehints#174).
- update to 1.11.0:
* Dropped support for Sphinx < 3.0
* Added support for alternative parameter names (``arg``, ``argument``, ``parameter``)
* Fixed import path for Signature (PR by Matthew Treinish)
* Fixed ``TypeError`` when formatting a parametrized ``typing.IO`` annotation
* Fixed data class displaying a return type in its ``__init__()`` method
- remove python-sphinx-autodoc-typehints-system-object.inv.patch (breaks the build)
OBS-URL: https://build.opensuse.org/request/show/888061
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-sphinx-autodoc-typehints?expand=0&rev=6
* Dropped support for Sphinx < 3.0
* Added support for alternative parameter names (``arg``, ``argument``, ``parameter``)
* Fixed import path for Signature (PR by Matthew Treinish)
* Fixed ``TypeError`` when formatting a parametrized ``typing.IO`` annotation
* Fixed data class displaying a return type in its ``__init__()`` method
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-sphinx-autodoc-typehints?expand=0&rev=14
- version update to 1.10.3
* Fixed ``TypeError`` (or wrong rendered class name) when an annotation is a generic class that has
a ``name`` property
* Fixed inner classes missing their parent class name(s) when rendered
* Fixed ``KeyError`` when encountering mocked annotations (``autodoc_mock_imports``)
* 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
* 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]``)
- added patches
fix use object.inv which comes with python-doc
+ python-sphinx-autodoc-typehints-system-object.inv.patch
OBS-URL: https://build.opensuse.org/request/show/782143
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-sphinx-autodoc-typehints?expand=0&rev=12
* 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+
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-sphinx-autodoc-typehints?expand=0&rev=10
* 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)
- Remove merged patch sphinx21.patch
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-sphinx-autodoc-typehints?expand=0&rev=8
