Sphinx: Add linked reference to a program option through an intersphinx inventory file

Created on 1 Mar 2017  路  3Comments  路  Source: sphinx-doc/sphinx

Problem

I am trying to add external references to a documentation. References to sections are properly found and linked. However, references to options are found, but no link is created.

Procedure to reproduce the problem

  • Add the following line to conf.py
intersphinx_mapping = {
    'ghdl':   ('http://ghdl-devfork.readthedocs.io/en/new-documentation-structure', None)
}
  • Add these to the body of index.rst:
:option:`ghdl:-C`
:ref:`GHDL Roadmap <ghdl:CHANGE:Roadmap>`

Error logs / results

I expect the option to be a link to -C, since both urls are shown in the inventory file:

$ curl -s http://ghdl-devfork.readthedocs.io/en/new-documentation-structure/objects.inv | tail -n+5 | openssl zlib -d
...
-C std:option 1 references/CommandReference.html#cmdoption-ghdl-mb-comments -
...
change:roadmap std:label -1 changelog/Roadmap.html#change-roadmap Roadmap | Future improvements
...

Reproducible project / your project

Environment info

  • OS: ReadTheDocs
  • Python version: 3
  • Sphinx version: 1.5.2
bug extensions

Most helpful comment

Thank you for reporting.
Fixed at 811df6b.

All 3 comments

Thank you for reporting.
Fixed at 811df6b.

Does this also fix #2822?

Thanks!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jfbu picture jfbu  路  3Comments

MichiK picture MichiK  路  3Comments

susmita1d picture susmita1d  路  3Comments

shimizukawa picture shimizukawa  路  3Comments

shimizukawa picture shimizukawa  路  3Comments