diff options
| author | Scott Gasch <[email protected]> | 2022-05-28 19:29:08 -0700 |
|---|---|---|
| committer | Scott Gasch <[email protected]> | 2022-05-28 19:29:08 -0700 |
| commit | 1e858172519e9339e4720b8bf9b39b6d9801e305 (patch) | |
| tree | 75306d5a4eb3a9b512646f0acc5c6174644348a6 /docs | |
| parent | 52ff365609d3f5a81cb79dc4464b19bd5860cfc0 (diff) | |
Tweak around docstring to make prettier sphinx autodocs.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/index.rst | 2 |
2 files changed, 5 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 2d1ed09..ef2a272 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,11 +38,14 @@ author = 'Scott Gasch' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.doctest', 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', ] +autodoc_typehints = "both" + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/index.rst b/docs/index.rst index 6e6da4d..3d9731e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Welcome to Scott's Python Utils's documentation! ================================================ .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :caption: Contents: modules |