diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2022-04-16 21:54:47 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2022-04-17 13:42:21 -0500 |
| commit | 613de4e1bb379d922cb7bd6c703fc81762f5d3bc (patch) | |
| tree | b25b7dcc56b80fa6e53a496c2ca1c4a543211629 /docs/conf.py | |
| parent | d6ee9143965d53dae44ca3a98802b2cc7ad6eeb7 (diff) | |
| download | requests-cache-613de4e1bb379d922cb7bd6c703fc81762f5d3bc.tar.gz | |
Move backend docs to user guide, separate from API reference docs
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py index 03f58f2..17fd900 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,7 +6,7 @@ Notes: * API reference docs are generated based on module docstrings * Google-style docstrings are used throughout the project * apidoc is used to generate source files for the majority of module docs -* The `api/` directory contains manually written docs for some modules +* The `api/` directory contains manually formatted sources for some modules * The `_templates` directory contains some Sphinx templates that modify auto-generated sources """ import os @@ -66,11 +66,10 @@ myst_enable_extensions = [ 'smartquotes', ] -# Ignore auto-generated pages for which manually written docs exist +# Ignore a subset of auto-generated pages exclude_patterns = [ '_build', f'{APIDOC_DIR.stem}/requests_cache.rst', - f'{APIDOC_DIR.stem}/requests_cache.backends.*.rst', f'{EXTRA_APIDOC_DIR.stem}/*', ] @@ -165,5 +164,6 @@ def patch_automodapi(app): def copy_module_docs(app): + """Copy manually written doc sources to apidoc directory""" for doc in EXTRA_APIDOC_DIR.iterdir(): copy(doc, APIDOC_DIR) |