aboutsummaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorRapptz <[email protected]>2015-12-04 00:16:34 -0500
committerRapptz <[email protected]>2015-12-04 00:16:34 -0500
commitf197c345832ff09fe081b7cb542de9288d0b780e (patch)
tree868d84f0708f9ceb9d3395bfd0223ef3c59a2514 /docs/conf.py
parentPoint to the docs in the README and clear up notes on breaking changes (diff)
downloaddiscord.py-f197c345832ff09fe081b7cb542de9288d0b780e.tar.xz
discord.py-f197c345832ff09fe081b7cb542de9288d0b780e.zip
Begin working on asyncio port.
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 3183d776..bb5d585c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -32,12 +32,19 @@ sys.path.insert(0, os.path.abspath('..'))
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.extlinks',
+ 'sphinx.ext.napoleon',
]
extlinks = {
'issue': ('https://github.com/Rapptz/discord.py/issues/%s', 'issue '),
}
+rst_prolog = """
+.. |coro| replace:: This function is a |corourl|_.
+.. |corourl| replace:: *coroutine*
+.. _corourl: https://docs.python.org/3/library/asyncio-task.html#coroutine
+"""
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']