aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorGravatar ChrisJL <[email protected]>2022-04-02 20:11:34 +0100
committerGravatar GitHub <[email protected]>2022-04-02 20:11:34 +0100
commit765284a5e436f7786619a5ba4c312d75df5e9dee (patch)
treef4748800698892fc9940c217b5507011ec614d27 /docs/conf.py
parentMerge pull request #39 from python-discord/revert-disnake (diff)
parentUse imperative mood in docstrings (diff)
Merge pull request #42 from python-discord/bump-d.py-and-add-BotBase
Bump d.py and add bot base
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 855a5856..8cbf5352 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -107,6 +107,16 @@ def setup(app: Sphinx) -> None:
app.connect("autodoc-skip-member", skip)
+ignored_modules = [
+ "async_rediscache",
+]
+
+# nitpick raises warnings as errors. This regex tells nitpick to ignore any warnings that match this regex.
+# This is a workaround for modules that do not have docs that can be linked out to.
+nitpick_ignore_regex = [
+ ("py:.*", "|".join([f".*{entry}.*" for entry in ignored_modules])),
+]
+
# -- Extension configuration -------------------------------------------------
# -- Options for todo extension ----------------------------------------------
@@ -132,6 +142,7 @@ intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"discord": ("https://discordpy.readthedocs.io/en/master/", None),
"aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
+ "statsd": ("https://statsd.readthedocs.io/en/v3.3/", ("_static/statsd_additional_objects.inv", None)),
}