Skip to content

Commit

Permalink
Merge pull request #58 from sphinx-contrib/doc-config-path
Browse files Browse the repository at this point in the history
Clarify and complete documentation about 'Configuration values'
  • Loading branch information
JasperCraeghs authored Apr 25, 2024
2 parents 84da2a5 + 1c3577b commit adb807f
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,22 @@ Configuration values

.. confval:: doxylink

The environment is set up with a dictionary mapping the interpreted text role to a tuple of tag file and prefix.
The keys of this dictionary must be lower-case. The prefix can be an absolute path or a path relative to `Sphinx'
output directory`_. An optional third element with the name of a Doxygen pdf file may be added. This will be used
when Sphinx uses the LaTeX builder. Otherwise, the second element of the tuple will be used to link to.
The environment is set up with a dictionary that maps the interpreted text role, which must be lower-case,
to a tuple with at most three elements, of which the third is optional:

- The path to the Doxygen tag file, which can be:

- absolute,
- relative to the location where `sphinx-build` is executed,
- a URL so that the file will be downloaded first.

- The path to the root of HTML documentation, which can be:

- absolute
- relative to `Sphinx' output directory`_.

- The filename of a Doxygen pdf file, to be used when Sphinx uses the LaTeX builder.
Otherwise, the second element of the tuple will be used to link to.

.. code-block:: python
Expand Down

0 comments on commit adb807f

Please sign in to comment.