[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Intersphinx tips and tricks (was Re: Acknowledgment)



On 2024-06-17 15:38, Michael R. Crusoe wrote:

"numpy": ("/usr/share/doc/python-numpy/html/", None),

Due to the "None", sphinx will append "objects.inv" to the base path to find the inventory file "/usr/share/doc/python-numpy/html/objects.inv" ; links will be made to the packaged docs starting with the path /usr/share/doc/python-numpy/html/ ; this only works if there is a Debian package providing those files. In this case that package is python-numpy-doc: https://packages.debian.org/sid/all/python-numpy-doc/filelist .

For all Debian packages of software that uses Sphinx to manage their documentation, we would ideally package that documentation so other packaged software that use the intersphinx feature can link to the packaged version. (Not to mention, the user benefit of offline docs that match the installed version).

Thanks for bringing the numpy docs back, Michael. It's very useful having access to them locally when internet is not available. We can also configure scipy docs to link to them.

Drew


Reply to: