diff options
| author | Martin Liska <mliska@suse.cz> | 2021-08-25 12:11:39 +0300 |
|---|---|---|
| committer | Martin Liska <mliska@suse.cz> | 2021-11-12 16:00:48 +0300 |
| commit | 9ec829fb503cb0a42427de711135bae123086abf (patch) | |
| tree | c8e5c23fade51500e3bea680742eacffb99b219b /doc | |
| parent | cee86909b9f4ca338bc41168e91226de520369c6 (diff) | |
texinfo: simplify reference emission.
The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.
Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.
while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.
It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/_static/conf.py.txt | 4 | ||||
| -rw-r--r-- | doc/faq.rst | 4 | ||||
| -rw-r--r-- | doc/usage/configuration.rst | 7 |
3 files changed, 15 insertions, 0 deletions
diff --git a/doc/_static/conf.py.txt b/doc/_static/conf.py.txt index 9078199b3..3077d1b93 100644 --- a/doc/_static/conf.py.txt +++ b/doc/_static/conf.py.txt @@ -319,6 +319,10 @@ texinfo_documents = [ # # texinfo_no_detailmenu = False +# If false, do not generate in manual @ref nodes. +# +# texinfo_cross_references = False + # -- A random example ----------------------------------------------------- import sys, os diff --git a/doc/faq.rst b/doc/faq.rst index 4b273023d..2e1081439 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -299,6 +299,10 @@ appear in the source. Emacs, on the other-hand, will by default replace :ref:`texinfo-links` +One can disable generation of the inline references in a document +with :confval:`texinfo_cross_references`. That makes +an info file more readable with stand-alone reader (``info``). + The exact behavior of how Emacs displays references is dependent on the variable ``Info-hide-note-references``. If set to the value of ``hide``, Emacs will hide both the ``*note:`` part and the ``target-id``. This is generally the best way diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 551ef5dbd..61878f225 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2499,6 +2499,13 @@ These options influence Texinfo output. .. versionadded:: 1.1 +.. confval:: texinfo_cross_references + + If false, do not generate inline references in a document. That makes + an info file more readable with stand-alone reader (``info``). + Default is ``True``. + + .. versionadded:: 4.4 .. _qthelp-options: |