diff options
| author | Jon Waltman <jonathan.waltman@gmail.com> | 2011-03-02 23:54:27 -0600 |
|---|---|---|
| committer | Jon Waltman <jonathan.waltman@gmail.com> | 2011-03-02 23:54:27 -0600 |
| commit | 6becf05f29dd624afba2074dc4949ed6a40e93ba (patch) | |
| tree | d447898c1ab99dc8b9c88b87335ab0e8d10a6916 /doc | |
| parent | a49ab4d78a87a9f65ae356dae074dd7db7037b0b (diff) | |
| parent | 0fe0f0ba1f41ea84ca61d2a8bc593fc9542ff28e (diff) | |
| download | sphinx-6becf05f29dd624afba2074dc4949ed6a40e93ba.tar.gz | |
Merge with https://bitbucket.org/birkenfeld/sphinx
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 11 | ||||
| -rw-r--r-- | doc/faq.rst | 7 | ||||
| -rw-r--r-- | doc/man/sphinx-build.rst | 4 |
3 files changed, 17 insertions, 5 deletions
diff --git a/doc/config.rst b/doc/config.rst index d8a07fa9..aa0eeed9 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -1180,13 +1180,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 diff --git a/doc/faq.rst b/doc/faq.rst index 334a3a4d..866ef108 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -215,7 +215,7 @@ Info files, try adding the following Emacs Lisp code to your start-up file, (widen) (goto-char (point-min)) (when (re-search-forward "^Generated by \\(Sphinx\\|Docutils\\)" - (save-excursion (search-forward "^_" nil t)) t) + (save-excursion (search-forward "\x1f" nil t)) t) (set (make-local-variable 'Info-hide-note-references) 'hide))))) @@ -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. diff --git a/doc/man/sphinx-build.rst b/doc/man/sphinx-build.rst index 30f824e8..b7212a84 100644 --- a/doc/man/sphinx-build.rst +++ b/doc/man/sphinx-build.rst @@ -47,6 +47,10 @@ latex man Generates manual pages. +texinfo + Generates Texinfo output that can be processed by :program:`makeinfo` to + generate an Info document. + text Generates a plain-text version of the documentation. |