diff options
| author | Cody Logan <clpo13@gmail.com> | 2020-01-08 10:55:28 -0800 |
|---|---|---|
| committer | Cody Logan <clpo13@gmail.com> | 2020-01-08 10:55:28 -0800 |
| commit | f96beef7d27f96d6ef6d3a2f647e36444afdb20e (patch) | |
| tree | 1418c6944959910e007c56e7fd17bc976db8e8ed | |
| parent | 21d800b1bfec1b3ca2fbd4cce8b8ade507c6382a (diff) | |
| download | alphanum-f96beef7d27f96d6ef6d3a2f647e36444afdb20e.tar.gz alphanum-f96beef7d27f96d6ef6d3a2f647e36444afdb20e.zip | |
Update sphinx config
| -rw-r--r-- | docs/conf.py | 12 | ||||
| -rw-r--r-- | docs/index.rst | 2 |
2 files changed, 12 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index f8370f3..afde33c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,8 +31,12 @@ release = '0.2.0' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.napoleon', + 'm2r', + 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.viewcode', + 'sphinx_rtd_theme', ] # Add any paths that contain templates here, relative to this directory. @@ -47,13 +51,17 @@ intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), } +napoleon_google_docstring = True +napoleon_use_param = True +napoleon_use_ivar = True + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index 7c3a505..1901192 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,8 @@ Welcome to alphanum's documentation! ==================================== +.. mdinclude:: ../README.md + .. toctree:: :maxdepth: 2 :caption: Contents: |