improved consistency for how docs refer to True and False

This commit is contained in:
EricFromCanada
2014-06-18 12:34:28 -04:00
parent 65e924a3e4
commit 178a97cd73
9 changed files with 41 additions and 40 deletions

View File

@@ -247,8 +247,8 @@ for details.
.. class:: ChangesBuilder .. class:: ChangesBuilder
This builder produces an HTML overview of all :rst:dir:`versionadded`, This builder produces an HTML overview of all :rst:dir:`versionadded`,
:rst:dir:`versionchanged` and :rst:dir:`deprecated` directives for the current :rst:dir:`versionchanged` and :rst:dir:`deprecated` directives for the
:confval:`version`. This is useful to generate a ChangeLog file, for current :confval:`version`. This is useful to generate a ChangeLog file, for
example. example.
Its name is ``changes``. Its name is ``changes``.

View File

@@ -308,8 +308,8 @@ Project information
If true, doctest flags (comments looking like ``# doctest: FLAG, ...``) at If true, doctest flags (comments looking like ``# doctest: FLAG, ...``) at
the ends of lines and ``<BLANKLINE>`` markers are removed for all code the ends of lines and ``<BLANKLINE>`` markers are removed for all code
blocks showing interactive Python sessions (i.e. doctests). Default is blocks showing interactive Python sessions (i.e. doctests). Default is
true. See the extension :mod:`~sphinx.ext.doctest` for more possibilities ``True``. See the extension :mod:`~sphinx.ext.doctest` for more
of including doctests. possibilities of including doctests.
.. versionadded:: 1.0 .. versionadded:: 1.0
.. versionchanged:: 1.1 .. versionchanged:: 1.1
@@ -404,7 +404,7 @@ documentation on :ref:`intl` for details.
If true, Sphinx generates uuid information for version tracking in message If true, Sphinx generates uuid information for version tracking in message
catalogs. catalogs.
The default is ``true``. The default is ``True``.
.. versionadded:: 1.3 .. versionadded:: 1.3
@@ -413,7 +413,7 @@ documentation on :ref:`intl` for details.
If true, Sphinx generates location information for messages in message If true, Sphinx generates location information for messages in message
catalogs. catalogs.
The default is ``true``. The default is ``True``.
.. versionadded:: 1.3 .. versionadded:: 1.3
@@ -1040,7 +1040,7 @@ These options influence LaTeX output.
documents will not get appendices. Also, howtos will have a simpler title documents will not get appendices. Also, howtos will have a simpler title
page. page.
* *toctree_only*: Must be ``True`` or ``False``. If ``True``, the *startdoc* * *toctree_only*: Must be ``True`` or ``False``. If true, the *startdoc*
document itself is not included in the output, only the documents document itself is not included in the output, only the documents
referenced by it via TOC trees. With this option, you can put extra stuff referenced by it via TOC trees. With this option, you can put extra stuff
in the master document that shows up in the HTML, but not the LaTeX output. in the master document that shows up in the HTML, but not the LaTeX output.
@@ -1343,7 +1343,7 @@ These options influence Texinfo output.
file. file.
* *category*: Specifies the section which this entry will appear in the * *category*: Specifies the section which this entry will appear in the
top-level ``DIR`` menu file. top-level ``DIR`` menu file.
* *toctree_only*: Must be ``True`` or ``False``. If ``True``, the *startdoc* * *toctree_only*: Must be ``True`` or ``False``. If true, the *startdoc*
document itself is not included in the output, only the documents document itself is not included in the output, only the documents
referenced by it via TOC trees. With this option, you can put extra stuff referenced by it via TOC trees. With this option, you can put extra stuff
in the master document that shows up in the HTML, but not the Texinfo in the master document that shows up in the HTML, but not the Texinfo
@@ -1452,9 +1452,9 @@ Options for the linkcheck builder
.. confval:: linkcheck_anchors .. confval:: linkcheck_anchors
True or false, whether to check the validity of ``#anchor``\ s in links. If true, check the validity of ``#anchor``\ s in links. Since this requires
Since this requires downloading the whole document, it's considerably slower downloading the whole document, it's considerably slower when enabled.
when enabled. Default is ``True``. Default is ``True``.
.. versionadded:: 1.2 .. versionadded:: 1.2
@@ -1464,7 +1464,7 @@ Options for the XML builder
.. confval:: xml_pretty .. confval:: xml_pretty
If True, pretty-print the XML. Default is ``True``. If true, pretty-print the XML. Default is ``True``.
.. versionadded:: 1.2 .. versionadded:: 1.2

View File

@@ -235,10 +235,10 @@ Debugging Tips
* Use ``node.pformat()`` and ``node.asdom().toxml()`` to generate a printable * Use ``node.pformat()`` and ``node.asdom().toxml()`` to generate a printable
representation of the document structure. representation of the document structure.
* Set the configuration variable :confval:`keep_warnings` to True so warnings * Set the configuration variable :confval:`keep_warnings` to ``True`` so
will be displayed in the generated output. warnings will be displayed in the generated output.
* Set the configuration variable :confval:`nitpicky` to True so that Sphinx * Set the configuration variable :confval:`nitpicky` to ``True`` so that Sphinx
will complain about references without a known target. will complain about references without a known target.
* Set the debugging options in the `Docutils configuration file * Set the debugging options in the `Docutils configuration file

View File

@@ -376,7 +376,7 @@ a matching identifier is found:
Reference a Python function; dotted names may be used. The role text needs Reference a Python function; dotted names may be used. The role text needs
not include trailing parentheses to enhance readability; they will be added not include trailing parentheses to enhance readability; they will be added
automatically by Sphinx if the :confval:`add_function_parentheses` config automatically by Sphinx if the :confval:`add_function_parentheses` config
value is true (the default). value is ``True`` (the default).
.. rst:role:: py:data .. rst:role:: py:data

View File

@@ -169,8 +169,8 @@ built:
.. confval:: pngmath_add_tooltips .. confval:: pngmath_add_tooltips
Default: true. If false, do not add the LaTeX code as an "alt" attribute for Default: ``True``. If false, do not add the LaTeX code as an "alt" attribute
math images. for math images.
.. versionadded:: 1.1 .. versionadded:: 1.1

View File

@@ -13,13 +13,14 @@ There are two additional directives when using this extension:
Use this directive like, for example, :rst:dir:`note`. Use this directive like, for example, :rst:dir:`note`.
It will only show up in the output if :confval:`todo_include_todos` is true. It will only show up in the output if :confval:`todo_include_todos` is
``True``.
.. rst:directive:: todolist .. rst:directive:: todolist
This directive is replaced by a list of all todo directives in the whole This directive is replaced by a list of all todo directives in the whole
documentation, if :confval:`todo_include_todos` is true. documentation, if :confval:`todo_include_todos` is ``True``.
There is also an additional config value: There is also an additional config value:

View File

@@ -52,7 +52,7 @@ Meta-information markup
By default, this markup isn't reflected in the output in any way (it helps By default, this markup isn't reflected in the output in any way (it helps
keep track of contributions), but you can set the configuration value keep track of contributions), but you can set the configuration value
:confval:`show_authors` to True to make them produce a paragraph in the :confval:`show_authors` to ``True`` to make them produce a paragraph in the
output. output.
@@ -61,7 +61,7 @@ Meta-information markup
The :rst:dir:`codeauthor` directive, which can appear multiple times, names The :rst:dir:`codeauthor` directive, which can appear multiple times, names
the authors of the described code, just like :rst:dir:`sectionauthor` names the authors of the described code, just like :rst:dir:`sectionauthor` names
the author(s) of a piece of documentation. It too only produces output if the author(s) of a piece of documentation. It too only produces output if
the :confval:`show_authors` configuration value is True. the :confval:`show_authors` configuration value is ``True``.
Index-generating markup Index-generating markup

View File

@@ -273,7 +273,7 @@ in the future.
.. data:: has_source .. data:: has_source
True if the reST document sources are copied (if :confval:`html_copy_source` True if the reST document sources are copied (if :confval:`html_copy_source`
is true). is ``True``).
.. data:: last_updated .. data:: last_updated
@@ -333,7 +333,7 @@ in the future.
.. data:: show_source .. data:: show_source
True if :confval:`html_show_sourcelink` is true. True if :confval:`html_show_sourcelink` is ``True``.
.. data:: sphinx_version .. data:: sphinx_version
@@ -372,7 +372,7 @@ are in HTML form), these variables are also available:
.. data:: sourcename .. data:: sourcename
The name of the copied source file for the current document. This is only The name of the copied source file for the current document. This is only
nonempty if the :confval:`html_copy_source` value is true. nonempty if the :confval:`html_copy_source` value is ``True``.
.. data:: toc .. data:: toc
@@ -384,14 +384,14 @@ are in HTML form), these variables are also available:
A callable yielding the global TOC tree containing the current page, rendered A callable yielding the global TOC tree containing the current page, rendered
as HTML bullet lists. Optional keyword arguments: as HTML bullet lists. Optional keyword arguments:
* ``collapse`` (true by default): if true, all TOC entries that are not * ``collapse`` (``True`` by default): if true, all TOC entries that are not
ancestors of the current page are collapsed ancestors of the current page are collapsed
* ``maxdepth`` (defaults to the max depth selected in the toctree directive): * ``maxdepth`` (defaults to the max depth selected in the toctree directive):
the maximum depth of the tree; set it to ``-1`` to allow unlimited depth the maximum depth of the tree; set it to ``-1`` to allow unlimited depth
* ``titles_only`` (false by default): if true, put only toplevel document * ``titles_only`` (``False`` by default): if true, put only toplevel document
titles in the tree titles in the tree
* ``includehidden`` (false by default): if true, the TOC tree will also * ``includehidden`` (``False`` by default): if true, the TOC tree will also
contain hidden entries. contain hidden entries.

View File

@@ -122,7 +122,7 @@ These themes are:
these options (which are inherited by the other themes): these options (which are inherited by the other themes):
- **nosidebar** (true or false): Don't include the sidebar. Defaults to - **nosidebar** (true or false): Don't include the sidebar. Defaults to
false. ``False``.
- **sidebarwidth** (an integer): Width of the sidebar in pixels. (Do not - **sidebarwidth** (an integer): Width of the sidebar in pixels. (Do not
include ``px`` in the value.) Defaults to 230 pixels. include ``px`` in the value.) Defaults to 230 pixels.
@@ -132,18 +132,18 @@ These themes are:
options: options:
- **rightsidebar** (true or false): Put the sidebar on the right side. - **rightsidebar** (true or false): Put the sidebar on the right side.
Defaults to false. Defaults to ``False``.
- **stickysidebar** (true or false): Make the sidebar "fixed" so that it - **stickysidebar** (true or false): Make the sidebar "fixed" so that it
doesn't scroll out of view for long body content. This may not work well doesn't scroll out of view for long body content. This may not work well
with all browsers. Defaults to false. with all browsers. Defaults to ``False``.
- **collapsiblesidebar** (true or false): Add an *experimental* JavaScript - **collapsiblesidebar** (true or false): Add an *experimental* JavaScript
snippet that makes the sidebar collapsible via a button on its side. snippet that makes the sidebar collapsible via a button on its side.
*Doesn't work with "stickysidebar".* Defaults to false. *Doesn't work with "stickysidebar".* Defaults to ``False``.
- **externalrefs** (true or false): Display external links differently from - **externalrefs** (true or false): Display external links differently from
internal links. Defaults to false. internal links. Defaults to ``False``.
There are also various color and font options that can change the color scheme There are also various color and font options that can change the color scheme
without having to write a custom stylesheet: without having to write a custom stylesheet:
@@ -152,7 +152,7 @@ These themes are:
- **footertextcolor** (CSS color): Text color for the footer line. - **footertextcolor** (CSS color): Text color for the footer line.
- **sidebarbgcolor** (CSS color): Background color for the sidebar. - **sidebarbgcolor** (CSS color): Background color for the sidebar.
- **sidebarbtncolor** (CSS color): Background color for the sidebar collapse - **sidebarbtncolor** (CSS color): Background color for the sidebar collapse
button (used when *collapsiblesidebar* is true). button (used when *collapsiblesidebar* is ``True``).
- **sidebartextcolor** (CSS color): Text color for the sidebar. - **sidebartextcolor** (CSS color): Text color for the sidebar.
- **sidebarlinkcolor** (CSS color): Link color for the sidebar. - **sidebarlinkcolor** (CSS color): Link color for the sidebar.
- **relbarbgcolor** (CSS color): Background color for the relation bar. - **relbarbgcolor** (CSS color): Background color for the relation bar.
@@ -218,10 +218,10 @@ These themes are:
<http://www.haiku-os.org/docs/userguide/en/contents.html>`_. The following <http://www.haiku-os.org/docs/userguide/en/contents.html>`_. The following
options are supported: options are supported:
- **full_logo** (true or false, default false): If this is true, the header - **full_logo** (true or false, default ``False``): If this is true, the
will only show the :confval:`html_logo`. Use this for large logos. If this header will only show the :confval:`html_logo`. Use this for large logos.
is false, the logo (if present) will be shown floating right, and the If this is false, the logo (if present) will be shown floating right, and
documentation title will be put in the header. the documentation title will be put in the header.
- **textcolor**, **headingcolor**, **linkcolor**, **visitedlinkcolor**, - **textcolor**, **headingcolor**, **linkcolor**, **visitedlinkcolor**,
**hoverlinkcolor** (CSS colors): Colors for various body elements. **hoverlinkcolor** (CSS colors): Colors for various body elements.
@@ -232,9 +232,9 @@ These themes are:
space which is a sparse resource on ebook readers. The following options space which is a sparse resource on ebook readers. The following options
are supported: are supported:
- **relbar1** (true or false, default true): If this is true, the - **relbar1** (true or false, default ``True``): If this is true, the
`relbar1` block is inserted in the epub output, otherwise it is omitted. `relbar1` block is inserted in the epub output, otherwise it is omitted.
- **footer** (true or false, default true): If this is true, the - **footer** (true or false, default ``True``): If this is true, the
`footer` block is inserted in the epub output, otherwise it is omitted. `footer` block is inserted in the epub output, otherwise it is omitted.
Creating themes Creating themes