diff options
| author |  Hassan Abouelela <[email protected]> | 2021-12-09 20:01:03 +0400 |
|---|---|---|
| committer | Hassan Abouelela <[email protected]> | 2021-12-09 20:01:03 +0400 |
| commit | c287e9900cceed9a728bc5125343fd35b9898178 (patch) | |
| tree | dda30bd92e94e42375e683d22f2b2ae9a64af1bf | |
| parent | Merge pull request #2 from python-discord/docs-build (diff) | |
Add InterSphinx Extension
Adds the intersphinx extension to link discord.py and python docs to the
autogenerated references.
| -rw-r--r-- | docs/changelog.rst | 1 | ||||
| -rw-r--r-- | docs/conf.py | 8 |
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst index 4954b59c..58b8e558 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,6 +5,7 @@ Changelog ========= +- :support:`3` Added intersphinx to docs. - :support:`2` Autogenerated docs. - :feature:`2` Regex utility. - :support:`1` Core package, poetry, and linting CI. diff --git a/docs/conf.py b/docs/conf.py index 4ab831d3..864168f6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ add_module_names = False # ones. extensions = [ "sphinx.ext.extlinks", + "sphinx.ext.intersphinx", "sphinx.ext.autodoc", "sphinx.ext.todo", "sphinx.ext.napoleon", @@ -169,6 +170,13 @@ extlinks = { } +# -- Options for intersphinx extension --------------------------------------- +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "discord": ("https://discordpy.readthedocs.io/en/master/", None), +} + + # -- Options for the linkcode extension -------------------------------------- def linkcode_resolve(domain: str, info: dict[str, str]) -> typing.Optional[str]: """ |