Deluge
diff options
| author | Chase Sterling <chase.sterling@gmail.com> | 2022-02-02 19:50:12 -0500 |
|---|---|---|
| committer | Calum Lind <calumlind+deluge@gmail.com> | 2022-02-11 08:48:58 +0000 |
| commit | dabb5053761644d06a4decaac7a4edaaa42f4412 (patch) | |
| tree | c7f2e2b496d81bf2c9e3215c765274536481e414 /docs/source/conf.py | |
| parent | aa74261d503dadba4263b6a92503ee6e182db7c5 (diff) | |
| download | deluge-dabb5053761644d06a4decaac7a4edaaa42f4412.tar.gz deluge-dabb5053761644d06a4decaac7a4edaaa42f4412.tar.bz2 deluge-dabb5053761644d06a4decaac7a4edaaa42f4412.zip | |
[Core] Document all exported core methods with type hints
Standardize docstrings in core.py to google standard.
Remove type hints in docstrings in favor of the ones in method signatures.
Use function signature type hints in autodoc generated docs.
Change Deferred type hints to strings.
Older versions of twisted (<21.7) don't
support generic Deferred type hinting,
this prevents crashes on those versions.
Closes: https://github.com/deluge-torrent/deluge/pull/359
Diffstat (limited to 'docs/source/conf.py')
| -rw-r--r-- | docs/source/conf.py | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index f04653e03..9c5853c73 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,6 +48,7 @@ extensions = [ 'sphinx.ext.coverage', 'sphinxcontrib.spelling', 'myst_parser', + 'sphinx_autodoc_typehints', ] napoleon_include_init_with_doc = True |