Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Using intersphinx for internal documentation

I would like to use intersphinx for internal documentation to crosslink between various pieces of internal services and internal documentation.

However, they are not on a secure internal network.

Is there a way to point intersphinx to objects.inv that is behind authentication?

Which authentication schemes are supported?

like image 695
Almad Avatar asked Oct 20 '22 03:10

Almad


1 Answers

I don't know if there's a way to pull objects.inv through authentication, but one alternative solution is to download the objects.inv file(s) you need to a location you can access without authentication, and then specify this local copy of the file(s) in the intersphinx_mapping parameter in conf.py:

intersphinx_mapping = {'keyname', ('uri/to/doc/repo/root', 'uri/to/local/objects.inv')}

While you'd have to re-pull the file periodically to ensure it's up to date, for the time being perhaps it's better than nothing?

like image 130
hBy2Py Avatar answered Nov 15 '22 11:11

hBy2Py