From 8ea92359baecc8a54f6b86023658958b47e40656 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 12 Jan 2016 13:36:12 +0900 Subject: [PATCH] Fix warnings in CHANGES and docs --- CHANGES | 11 +++++------ doc/config.rst | 4 ++-- doc/ext/graphviz.rst | 4 ++-- doc/ext/math.rst | 4 ++-- doc/intl.rst | 2 +- doc/tutorial.rst | 5 +++-- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/CHANGES b/CHANGES index b1f2a3060..54ea9694c 100644 --- a/CHANGES +++ b/CHANGES @@ -943,13 +943,12 @@ Features added * Command-line interfaces: - PR#75: Added ``--follow-links`` option to sphinx-apidoc. - - #869: sphinx-build now has the option :option:`-T` for printing the full + - #869: sphinx-build now has the option ``-T`` for printing the full traceback after an unhandled exception. - - sphinx-build now supports the standard :option:`--help` and - :option:`--version` options. + - sphinx-build now supports the standard ``--help`` and ``--version`` options. - sphinx-build now provides more specific error messages when called with invalid options or arguments. - - sphinx-build now has a verbose option :option:`-v` which can be repeated for + - sphinx-build now has a verbose option ``-v`` which can be repeated for greater effect. A single occurrence provides a slightly more verbose output than normal. Two or more occurrences of this option provides more detailed output which may be useful for debugging. @@ -971,7 +970,7 @@ Features added stemming routines. Saves about 20 seconds when building the Python documentation. - PR#108: Add experimental support for parallel building with a new - :option:`-j` option. + :option:`sphinx-build -j` option. Documentation ------------- @@ -1561,7 +1560,7 @@ Features added * General: - Added a "nitpicky" mode that emits warnings for all missing - references. It is activated by the :option:`-n` command-line switch + references. It is activated by the :option:`sphinx-build -n` command-line switch or the `nitpicky` config value. - Added ``latexpdf`` target in quickstart Makefile. diff --git a/doc/config.rst b/doc/config.rst index 3fd1df658..086e0dc0d 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -234,7 +234,7 @@ General configuration If true, Sphinx will warn about *all* references where the target cannot be found. Default is ``False``. You can activate this mode temporarily using - the :option:`-n` command-line switch. + the :option:`-n ` command-line switch. .. versionadded:: 1.0 @@ -580,7 +580,7 @@ that use Sphinx's HTMLWriter class. A dictionary of values to pass into the template engine's context for all pages. Single values can also be put in this dictionary using the - :option:`-A` command-line option of ``sphinx-build``. + :option:`-A ` command-line option of ``sphinx-build``. .. versionadded:: 0.5 diff --git a/doc/ext/graphviz.rst b/doc/ext/graphviz.rst index ef57da4fd..db7fe7ea6 100644 --- a/doc/ext/graphviz.rst +++ b/doc/ext/graphviz.rst @@ -97,8 +97,8 @@ There are also these new config values: Since this setting is not portable from system to system, it is normally not useful to set it in ``conf.py``; rather, giving it on the - :program:`sphinx-build` command line via the :option:`-D` option should be - preferable, like this:: + :program:`sphinx-build` command line via the :option:`-D ` + option should be preferable, like this:: sphinx-build -b html -D graphviz_dot=C:\graphviz\bin\dot.exe . _build/html diff --git a/doc/ext/math.rst b/doc/ext/math.rst index 4c1546109..a2499324c 100644 --- a/doc/ext/math.rst +++ b/doc/ext/math.rst @@ -117,8 +117,8 @@ built: Since this setting is not portable from system to system, it is normally not useful to set it in ``conf.py``; rather, giving it on the - :program:`sphinx-build` command line via the :option:`-D` option should be - preferable, like this:: + :program:`sphinx-build` command line via the :option:`-D ` + option should be preferable, like this:: sphinx-build -b html -D pngmath_latex=C:\tex\latex.exe . _build/html diff --git a/doc/intl.rst b/doc/intl.rst index a358c436a..bd4f9e889 100644 --- a/doc/intl.rst +++ b/doc/intl.rst @@ -63,7 +63,7 @@ be translated you need to follow these instructions: msgfmt "usage.po" -o "locale/es/LC_MESSAGES/usage.mo" * Set :confval:`locale_dirs` to ``["locale/"]``. -* Set :confval:`language` to ``es`` (also possible via :option:`-D`). +* Set :confval:`language` to ``es`` (also possible via :option:`-D `). * Run your desired build. diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 95bd61ebc..385746f72 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -122,8 +122,9 @@ this:: $ sphinx-build -b html sourcedir builddir where *sourcedir* is the :term:`source directory`, and *builddir* is the -directory in which you want to place the built documentation. The :option:`-b` -option selects a builder; in this example Sphinx will build HTML files. +directory in which you want to place the built documentation. +The :option:`-b ` option selects a builder; in this example +Sphinx will build HTML files. |more| See :ref:`invocation` for all options that :program:`sphinx-build` supports.