diff options
| author | Monty Taylor <mordred@inaugust.com> | 2017-08-10 09:38:03 -0500 |
|---|---|---|
| committer | Monty Taylor <mordred@inaugust.com> | 2017-08-10 09:45:54 -0500 |
| commit | fb95d09b3697ebbcad32828d81333d497aa6f5f0 (patch) | |
| tree | 60d492993e292a9a40cb28fae2f3a43946c5491f /test-requirements.txt | |
| parent | ad966ccc46bcceb9c1c29da972b14dd6967ff6a4 (diff) | |
| download | zuul-fb95d09b3697ebbcad32828d81333d497aa6f5f0.tar.gz | |
Add sphinx-autodoc-typehits sphinx extension
Since we have some python3 typehints in the code now, there is no need
to duplicate that information in sphinx docstrings.
sphinx-autodoc-typehints reads type annotations and updates :type:
information for :param: and :rtype: for :returns:. The results are the
same as if :param: had been given a type or a :type: directive, so this
is essentially just in service of using the same information for both
type hints/static analysis and for documentation.
There is a bug in the released version in that it does not consider
someone setting a default domain explicitly such as we do in zuul. A
pull request has been submitted that fixes the issue
Change-Id: I900a58eb6503cfee3cdff83e6cc376b5e2da3d44
Depends-On: https://github.com/agronholm/sphinx-autodoc-typehints/pull/19
Diffstat (limited to 'test-requirements.txt')
| -rw-r--r-- | test-requirements.txt | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/test-requirements.txt b/test-requirements.txt index bf8b97946..b44429780 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -11,6 +11,7 @@ python-subunit testrepository>=0.0.17 testtools>=0.9.32 sphinxcontrib-programoutput +sphinx-autodoc-typehints mock PyMySQL mypy |