diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-09-08 16:59:54 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-09-08 16:59:54 -0500 |
| commit | ef6d9013e34712973af73e58a97ef9eb60a904bd (patch) | |
| tree | 1de206c9ce2d5cec45cc5e1c5f685cc2a4abc579 | |
| parent | 09a9371fdf84d5c84626b31a46befaa3646eb4a9 (diff) | |
| download | requests-cache-ef6d9013e34712973af73e58a97ef9eb60a904bd.tar.gz | |
Use sphinx_autodoc_typehints extension instead of autodoc's built-in type hints
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | docs/conf.py | 4 |
2 files changed, 6 insertions, 3 deletions
@@ -9,9 +9,8 @@ [](https://pypi.org/project/requests-cache) ## Summary -**requests-cache** is a transparent, persistent cache for the python [requests](http://python-requests.org) -library. It can substantially improve performance and reduce network traffic, making it an ideal -companion for almost any application using `requests`. +**requests-cache** is a transparent, persistent cache that provides an easy way to get better +performance with the python [requests](http://python-requests.org) library. <!-- RTD-IGNORE --> Complete project documentation can be found at [requests-cache.readthedocs.io](https://requests-cache.readthedocs.io). diff --git a/docs/conf.py b/docs/conf.py index 4bb138f..4e45871 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -84,6 +84,10 @@ copybutton_prompt_is_regexp = True # Generate labels in the format <page>:<section> autosectionlabel_prefix_document = True +# Use sphinx_autodoc_typehints extension instead of autodoc's built-in type hints +autodoc_typehints = 'none' +always_document_param_types = True + # Use apidoc to auto-generate rst sources apidoc_module_dir = PACKAGE_DIR apidoc_output_dir = 'modules' |