From 20dcbd367d646a306e61bad4575428b246d7a2f2 Mon Sep 17 00:00:00 2001 From: Timotheus Kampik Date: Sat, 24 Feb 2018 16:45:04 +0100 Subject: [PATCH] #4244 use more generic Python *3* examples --- doc/ext/intersphinx.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/ext/intersphinx.rst b/doc/ext/intersphinx.rst index 6e3a4aaba..b8ae104b3 100644 --- a/doc/ext/intersphinx.rst +++ b/doc/ext/intersphinx.rst @@ -87,7 +87,7 @@ linking: To add links to modules and objects in the Python standard library documentation, use:: - intersphinx_mapping = {'python': ('https://docs.python.org/3.6', None)} + intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} This will download the corresponding :file:`objects.inv` file from the Internet and generate links to the pages under the given URI. The downloaded @@ -97,12 +97,12 @@ linking: A second example, showing the meaning of a non-``None`` value of the second tuple item:: - intersphinx_mapping = {'python': ('https://docs.python.org/3.6', + intersphinx_mapping = {'python': ('https://docs.python.org/3', 'python-inv.txt')} This will read the inventory from :file:`python-inv.txt` in the source directory, but still generate links to the pages under - ``https://docs.python.org/3.6``. It is up to you to update the inventory file + ``https://docs.python.org/3``. It is up to you to update the inventory file as new objects are added to the Python documentation. **Multiple target for the inventory** @@ -116,7 +116,7 @@ linking: this to specify mirror sites for server downtime of the primary inventory:: - intersphinx_mapping = {'python': ('https://docs.python.org/3.6', + intersphinx_mapping = {'python': ('https://docs.python.org/3', (None, 'python-inv.txt'))} .. confval:: intersphinx_cache_limit @@ -141,7 +141,7 @@ Showing all links of an Intersphinx mapping file To show all Intersphinx links and their targets of an Intersphinx mapping file, run ``python -msphinx.ext.intersphinx url-or-path``. This is helpful when searching for the root cause of a broken -Intersphinx link in a documentation project. The following example prints the Intersphinx mapping of the Python 3.6 +Intersphinx link in a documentation project. The following example prints the Intersphinx mapping of the Python 3 documentation:: - $ python -msphinx.ext.intersphinx https://docs.python.org/3.6/objects.inv + $ python -msphinx.ext.intersphinx https://docs.python.org/3/objects.inv