Jon Waltman avatar Jon Waltman committed 97cebb6

Document :confval:`texinfo_domain_indices` and update quickstart.

Comments (0)

Files changed (3)

 
    .. 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
 
 
 - 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.

sphinx/quickstart.py

 # 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
 ]
 
 # 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 = '''
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.