diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-03-20 15:19:58 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-03-24 16:46:27 -0500 |
| commit | ab18e06217a8a1902d1859aae6b033f469b2232b (patch) | |
| tree | 98136dffa4d16ed3d645e2bdee1ac60421001ff7 /docs/conf.py | |
| parent | 78819897213ec3bff57d4c7094fd585dbb8d48d4 (diff) | |
| download | requests-cache-ab18e06217a8a1902d1859aae6b033f469b2232b.tar.gz | |
More usage examples, formatting, and editing for Readme + Sphinx docs
* Closes #135, #165
* Add a 'Summary' section at the top of the Readme explaining the scope of requests-cache and why you would want to use it
* Add some more info explaining the difference between using `CachedSession` directly vs. patching with `install_cache()`
* Move basic examples from 'User Guide' section into Readme
* Include Readme in Sphinx docs (using `.. mdinclude::`) and remove duplicate sections
* Include Contributing guide in Sphinx docs
* Convert History doc to markdown and include in Sphinx docs
* Use `automod` options to move main cache documentation from `CacheMixin` back to to `CachedSession`, since that's probably where a user will look first
* Add more detailed usage examples to an 'Advanced Usage' section for `CachedSession` options (`filter_fn`, `ignore_parameters`, etc.)
* Update example scripts and move them to `examples/` folder
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index d152386..f2c2ae8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,19 +21,21 @@ templates_path = ['_templates'] # Sphinx extension modules extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.autosectionlabel', 'sphinx.ext.intersphinx', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinx_autodoc_typehints', 'sphinx_copybutton', # 'sphinxcontrib.apidoc', - # 'm2r2', + 'm2r2', ] # Enable automatic links to other projects' Sphinx docs intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), 'requests': ('https://requests.readthedocs.io/en/master/', None), + 'urllib3': ('http://urllib3.readthedocs.org/en/latest', None), } # Enable Google-style docstrings |