Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify and complete documentation about 'Configuration values' #58

Merged
merged 1 commit into from
Apr 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading