diff options
author | Jonathan Waltman <jonathan.waltman@gmail.com> | 2013-02-20 04:09:50 -0600 |
---|---|---|
committer | Jonathan Waltman <jonathan.waltman@gmail.com> | 2013-02-20 04:09:50 -0600 |
commit | 5e022d27833bac115542ca6b728ea6c4f4c49e62 (patch) | |
tree | 0d3ba278f5c8e0e3f0ec790a8757b81818c4d95d /doc/faq.rst | |
parent | a6aead13e9ed43826737078d9f846051d66de540 (diff) | |
download | sphinx-5e022d27833bac115542ca6b728ea6c4f4c49e62.tar.gz |
[texinfo] Update CHANGES and relevant documentation.
Diffstat (limited to 'doc/faq.rst')
-rw-r--r-- | doc/faq.rst | 35 |
1 files changed, 13 insertions, 22 deletions
diff --git a/doc/faq.rst b/doc/faq.rst index 1d948737..e1c95b08 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -173,17 +173,11 @@ some notes: Texinfo info ------------ -The Texinfo builder is currently in an experimental stage but has successfully -been used to build the documentation for both Sphinx and Python. The intended -use of this builder is to generate Texinfo that is then processed into Info -files. - There are two main programs for reading Info files, ``info`` and GNU Emacs. The ``info`` program has less features but is available in most Unix environments and can be quickly accessed from the terminal. Emacs provides better font and color display and supports extensive customization (of course). - .. _texinfo-links: Displaying Links @@ -197,13 +191,13 @@ to this section would look like:: In the stand-alone reader, ``info``, references are displayed just as they appear in the source. Emacs, on the other-hand, will by default replace -``\*note:`` with ``see`` and hide the ``target-id``. For example: +``*note:`` with ``see`` and hide the ``target-id``. For example: :ref:`texinfo-links` 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 +both the ``*note:`` part and the ``target-id``. This is generally the best way to view Sphinx-based documents since they often make frequent use of links and do not take this limitation into account. However, changing this variable affects how all Info documents are displayed and most due take this behavior @@ -244,9 +238,6 @@ The following notes may be helpful if you want to create Texinfo files: - 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. - - Links to external Info files can be created using the somewhat official URI scheme ``info``. For example:: @@ -256,18 +247,18 @@ The following notes may be helpful if you want to create Texinfo files: info:Texinfo#makeinfo_options -- Inline markup appears as follows in Info: +- Inline markup - * strong -- \*strong\* - * emphasis -- _emphasis_ - * literal -- \`literal' + The standard formatting for ``*strong*`` and ``_emphasis_`` can + result in ambiguous output when used to markup parameter names and + other values. Since this is a fairly common practice, the default + formatting has been changed so that ``emphasis`` and ``strong`` are + now displayed like ```literal'``\s. - It is possible to change this behavior using the Texinfo command - ``@definfoenclose``. For example, to make inline markup more closely resemble - reST, add the following to your :file:`conf.py`:: + The standard formatting can be re-enabled by adding the following to + your :file:`conf.py`:: - texinfo_elements = {'preamble': """\ - @definfoenclose strong,**,** - @definfoenclose emph,*,* - @definfoenclose code,`@w{}`,`@w{}` + texinfo_elements = {'preamble': """ + @definfoenclose strong,*,* + @definfoenclose emph,_,_ """} |