diff options
| author | Rapptz <[email protected]> | 2016-01-10 00:39:48 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2016-01-10 00:39:48 -0500 |
| commit | c6b31c9663c60d72b64a0e3eab984d48681004a0 (patch) | |
| tree | f2b8d0dad7b878b8ae1ea48cc4d01e708f7263ee /docs | |
| parent | Add a Whats New page to have a nicer changelog. (diff) | |
| download | discord.py-c6b31c9663c60d72b64a0e3eab984d48681004a0.tar.xz discord.py-c6b31c9663c60d72b64a0e3eab984d48681004a0.zip | |
Attempt to satisfy RTD by using sphinxcontrib.napoleon.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 85bdbd89..0d4a84d9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,8 @@ import sys import os import re +on_rtd = os.getenv('READTHEDOCS') == 'True' + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -32,9 +34,13 @@ sys.path.insert(0, os.path.abspath('..')) extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', - 'sphinx.ext.napoleon', ] +if on_rtd: + extensions.append('sphinxcontrib.napoleon') +else: + extensions.append('sphinx.ext.napoleon') + autodoc_member_order = 'bysource' extlinks = { @@ -153,7 +159,7 @@ 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied |