mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Document :confval:texinfo_domain_indices and update quickstart.
This commit is contained in:
@@ -1170,13 +1170,22 @@ These options influence Texinfo output.
|
||||
|
||||
.. versionadded:: 1.1
|
||||
|
||||
|
||||
.. confval:: texinfo_appendices
|
||||
|
||||
A list of document names to append as an appendix to all manuals.
|
||||
|
||||
.. versionadded:: 1.1
|
||||
|
||||
.. confval:: texinfo_domain_indices
|
||||
|
||||
If true, generate domain-specific indices in addition to the general index.
|
||||
For e.g. the Python domain, this is the global module index. Default is
|
||||
``True``.
|
||||
|
||||
This value can be a bool or a list of index names that should be generated,
|
||||
like for :confval:`html_domain_indices`.
|
||||
|
||||
.. versionadded:: 1.1
|
||||
|
||||
.. confval:: texinfo_elements
|
||||
|
||||
|
||||
@@ -227,9 +227,8 @@ The following notes may be helpful if you want to create Texinfo files:
|
||||
|
||||
- Each section corresponds to a different ``node`` in the Info file.
|
||||
|
||||
- Some characters cannot be properly escaped in menu entries and xrefs. The
|
||||
following characters are replaced by spaces in these contexts: ``@``, ``{``,
|
||||
``}``, ``.``, ``,``, and ``:``.
|
||||
- Colons (``:``) cannot be properly escaped in menu entries and xrefs.
|
||||
They will be replaced with semicolons (``;``).
|
||||
|
||||
- In the HTML and Tex output, the word ``see`` is automatically inserted before
|
||||
all xrefs.
|
||||
|
||||
@@ -258,6 +258,7 @@ man_pages = [
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output ------------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
@@ -269,7 +270,10 @@ texinfo_documents = [
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
texinfo_appendices = []
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
'''
|
||||
|
||||
EPUB_CONFIG = '''
|
||||
|
||||
Reference in New Issue
Block a user