Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add intersphinx links for requests #819

Merged
merged 2 commits into from Oct 10, 2021
Merged

Add intersphinx links for requests #819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd566e7
Add requests to intersphinx
bhrutledge Oct 10, 2021
a935012
Update docs requirements
bhrutledge Oct 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/conf.py
View file
Open in desktop
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
View file
Open in desktop
@@ -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