Skip to content

Commit

Permalink
Add intersphinx links for requests (#819)
Browse files Browse the repository at this point in the history
* Add requests to intersphinx

* Update docs requirements
  • Loading branch information
bhrutledge committed Oct 10, 2021
1 parent 9d26a5f commit 658037f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
8 changes: 5 additions & 3 deletions docs/conf.py
Expand Up @@ -276,15 +276,17 @@
"https://upload.pypi.org/legacy",
]

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"https://docs.python.org/": None}
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"requests": ("https://docs.python-requests.org/en/latest/", None),
}

# Be strict about the invalid references:
nitpicky = True

# TODO: Try to add these to intersphinx_mapping
nitpick_ignore_regex = [
(r"py:.*", r"(pkginfo|requests|IO).*"),
(r"py:.*", r"(pkginfo|IO).*"),
]

# -- Options for apidoc output ------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
@@ -1,5 +1,5 @@
doc8>=0.8.0
furo >= 2021.7.5b38
furo>=2021.10.09
readme-renderer>=17.4
Sphinx>=1.7.0
Sphinx>=4.2.0
sphinxcontrib-programoutput>=0.17

0 comments on commit 658037f

Please sign in to comment.