Skip to content

Commit 72e3210

Browse files
committed
Adding intersphinx for docs linking.
1 parent 17676f9 commit 72e3210

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/conf.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
'sphinx.ext.autodoc',
4040
'sphinx.ext.autosummary',
4141
'sphinx.ext.doctest',
42+
'sphinx.ext.intersphinx',
4243
'sphinx.ext.todo',
4344
'sphinx.ext.viewcode',
4445
]
@@ -284,3 +285,13 @@
284285
issue_uri=issue_uri,
285286
issue_uri_template=issue_uri_template,
286287
)
288+
289+
# Configuration for intersphinx:
290+
# Refer to the Python standard library and oauth2client library.
291+
# NOTE: We also have a custom mapping for items in the stdlib not
292+
# included in https://docs.python.org/objects.inv
293+
intersphinx_mapping = {
294+
'python': ('https://docs.python.org/', None),
295+
'pythonlocal': ('https://docs.python.org/2.7/', 'python-inv.txt'),
296+
'oauth2client': ('http://google.github.io/oauth2client/', None),
297+
}

docs/python-inv.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Sphinx inventory version 1
2+
# Project: Python
3+
# Version: 2.7
4+
types mod library/types.html
5+
types.NoneType data library/types.html
6+
types.NoneType class library/types.html
7+
True data library/constants.html
8+
False data library/constants.html
9+
None data library/constants.html
10+
exceptions mod library/exceptions.html
11+
exceptions.ValueError exception library/exceptions.html
12+
exceptions.TypeError exception library/exceptions.html

0 commit comments

Comments
 (0)