mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge branch '1.8'
resolved Conflicts: doc/development/tutorials/todo.rst sphinx/locale/__init__.py sphinx/search/zh.py
This commit is contained in:
@@ -117,7 +117,7 @@ General configuration
|
||||
.. confval:: source_suffix
|
||||
|
||||
The file extensions of source files. Sphinx considers the files with this
|
||||
suffix as sources. This value can be a dictionary mapping file extensions
|
||||
suffix as sources. The value can be a dictionary mapping file extensions
|
||||
to file types. For example::
|
||||
|
||||
source_suffix = {
|
||||
@@ -128,13 +128,14 @@ General configuration
|
||||
|
||||
By default, Sphinx only supports ``'restructuredtext'`` file type. You can
|
||||
add a new file type using source parser extensions. Please read a document
|
||||
of the extension to know what file type the extension supports.
|
||||
of the extension to know which file type the extension supports.
|
||||
|
||||
This also allows a list of file extensions. In that case, Sphinx conciders
|
||||
that all they are ``'restructuredtext'``. Default is
|
||||
``{'.rst': 'restructuredtext'}``.
|
||||
The value may also be a list of file extensions: then Sphinx will consider
|
||||
that they all map to the ``'restructuredtext'`` file type.
|
||||
|
||||
.. note:: file extensions have to start with dot (like ``.rst``).
|
||||
Default is ``{'.rst': 'restructuredtext'}``.
|
||||
|
||||
.. note:: file extensions have to start with a dot (e.g. ``.rst``).
|
||||
|
||||
.. versionchanged:: 1.3
|
||||
Can now be a list of extensions.
|
||||
@@ -788,10 +789,10 @@ These options influence Math notations.
|
||||
|
||||
.. confval:: math_eqref_format
|
||||
|
||||
A string that are used for format of label of references to equations.
|
||||
As a special character, ``{number}`` will be replaced to equaition number.
|
||||
A string used for formatting the labels of references to equations.
|
||||
The ``{number}`` place-holder stands for the equation number.
|
||||
|
||||
Example: ``'Eq.{number}'`` is rendered as ``Eq.10``
|
||||
Example: ``'Eq.{number}'`` gets rendered as, for example, ``Eq.10``.
|
||||
|
||||
.. confval:: math_numfig
|
||||
|
||||
@@ -2731,7 +2732,7 @@ Options for the C++ domain
|
||||
A list of strings that the parser additionally should accept as attributes
|
||||
with one argument. That is, if ``my_align_as`` is in the list, then
|
||||
``my_align_as(X)`` is parsed as an attribute for all strings ``X`` that have
|
||||
balanced brances (``()``, ``[]``, and ``{}``). This can for example be used
|
||||
balanced braces (``()``, ``[]``, and ``{}``). This can for example be used
|
||||
when attributes have been ``#define`` d for portability.
|
||||
|
||||
.. versionadded:: 1.5
|
||||
|
||||
@@ -427,7 +427,7 @@ There are also new config values that you can set:
|
||||
|
||||
This value controls the behavior of :option:`sphinx-build -W` during
|
||||
importing modules.
|
||||
If ``False`` is given, autodoc forcely suppresses the error if the imported
|
||||
If ``False`` is given, autodoc forcedly suppresses the error if the imported
|
||||
module emits warnings. By default, ``True``.
|
||||
|
||||
.. confval:: autodoc_inherit_docstrings
|
||||
|
||||
@@ -75,7 +75,7 @@ a comma-separated list of group names.
|
||||
|
||||
* ``pyversion``, a string option, can be used to specify the required Python
|
||||
version for the example to be tested. For instance, in the following case
|
||||
the example will be tested only for Python versions greather than 3.3::
|
||||
the example will be tested only for Python versions greater than 3.3::
|
||||
|
||||
.. doctest::
|
||||
:pyversion: > 3.3
|
||||
|
||||
@@ -130,7 +130,7 @@ Google vs NumPy
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Napoleon supports two styles of docstrings: `Google`_ and `NumPy`_. The
|
||||
main difference between the two styles is that Google uses indention to
|
||||
main difference between the two styles is that Google uses indentation to
|
||||
separate sections, whereas NumPy uses underlines.
|
||||
|
||||
Google style:
|
||||
|
||||
@@ -654,7 +654,7 @@ Glossary
|
||||
.. rst:directive:: .. glossary::
|
||||
|
||||
This directive must contain a reST definition-list-like markup with terms and
|
||||
definitions. The definitions will then be referencable with the
|
||||
definitions. The definitions will then be referenceable with the
|
||||
:rst:role:`term` role. Example::
|
||||
|
||||
.. glossary::
|
||||
|
||||
@@ -762,7 +762,7 @@ Some directives support options:
|
||||
Anonymous Entities
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
C++ supposrts anonymous namespaces, classes, enums, and unions.
|
||||
C++ supports anonymous namespaces, classes, enums, and unions.
|
||||
For the sake of documentation they must be given some name that starts with ``@``,
|
||||
e.g., ``@42`` or ``@data``.
|
||||
These names can also be used in cross-references and (type) expressions,
|
||||
@@ -1155,7 +1155,7 @@ There is a set of directives allowing documenting command-line programs:
|
||||
Run a module as a script.
|
||||
|
||||
The directive will create cross-reference targets for the given options,
|
||||
referencable by :rst:role:`option` (in the example case, you'd use something
|
||||
referenceable by :rst:role:`option` (in the example case, you'd use something
|
||||
like ``:option:`dest_dir```, ``:option:`-m```, or ``:option:`--module```).
|
||||
|
||||
``cmdoption`` directive is a deprecated alias for the ``option`` directive.
|
||||
@@ -1163,7 +1163,7 @@ There is a set of directives allowing documenting command-line programs:
|
||||
.. rst:directive:: .. envvar:: name
|
||||
|
||||
Describes an environment variable that the documented code or program uses
|
||||
or defines. Referencable by :rst:role:`envvar`.
|
||||
or defines. Referenceable by :rst:role:`envvar`.
|
||||
|
||||
.. rst:directive:: .. program:: name
|
||||
|
||||
|
||||
Reference in New Issue
Block a user