IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update docs about intersphinx and basic auth support

Browse Source 
This was added in #2089 but the docs don't mention it.
This commit is contained in:
Santos Gallegos 2019-11-27 15:23:52 -05:00
parent 8c7faed6fc
commit a72d8f6808
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/usage/extensions/intersphinx.rst
View File

@ -148,3 +148,13 @@ project. The following example prints the Intersphinx mapping of the Python 3
documentation::
$ python -msphinx.ext.intersphinx https://docs.python.org/3/objects.inv
Using Intersphinx with inventory file under login
-------------------------------------------------
If the inventory file is under login,
you can still use Intersphinx if the site supports Basic Authorization::
intersphinx_mapping = {'python': ('https://user:password@docs.python.org/3', None)}
The user and password will be stripped from the URL when generating the links.