IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#4255 improve conciseness

Browse Source
This commit is contained in:
Timotheus Kampik 2018-07-19 21:10:16 +02:00
parent 94b467dbc8
commit 395d60d49e
1 changed files with 30 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
doc/usage/configuration.rst
View File

@ -1766,9 +1766,8 @@ information.
documentclass, toctree_only)``, where the items are: documentclass, toctree_only)``, where the items are:
*startdocname* *startdocname*
String that specifies the relative path (without file suffix) from the String that specifies the :term:`document name` of the LaTeX file's master
source directory to the document that is the master document of the LaTeX document. All documents referenced by the *startdoc* document in TOC trees
file. All documents referenced by the *startdoc* document in TOC trees
will be included in the LaTeX file. (If you want to use the default master will be included in the LaTeX file. (If you want to use the default master
document for your LaTeX build, provide your :confval:`master_doc` here.) document for your LaTeX build, provide your :confval:`master_doc` here.)
@ -1776,32 +1775,29 @@ information.
File name of the LaTeX file in the output directory. File name of the LaTeX file in the output directory.
*title* *title*
LaTeX document title. Can be empty to use the title of the LaTeX document title. Can be empty to use the title of the *startdoc*
*startdoc* document. This is inserted as LaTeX markup, so special document. This is inserted as LaTeX markup, so special characters like a
characters like a backslash or ampersand must be represented by the proper backslash or ampersand must be represented by the proper LaTeX commands if
LaTeX commands if they are to be inserted literally. they are to be inserted literally.
* *author* *author*
Author for the LaTeX document. The same LaTeX markup caveat as Author for the LaTeX document. The same LaTeX markup caveat as for *title*
for *title* applies. Use ``\\and`` to separate multiple authors, as in: applies. Use ``\\and`` to separate multiple authors, as in:
``'John \\and Sarah'`` (backslashes must be Python-escaped to reach ``'John \\and Sarah'`` (backslashes must be Python-escaped to reach LaTeX).
LaTeX).
*documentclass* *documentclass*
Normally, one of ``'manual'`` or ``'howto'`` (provided Normally, one of ``'manual'`` or ``'howto'`` (provided by Sphinx and based
by Sphinx and based on ``'report'``, resp. ``'article'``; Japanese on ``'report'``, resp. ``'article'``; Japanese documents use ``'jsbook'``,
documents use ``'jsbook'``, resp. ``'jreport'``.) "howto" (non-Japanese) resp. ``'jreport'``.) "howto" (non-Japanese) documents will not get
documents will not get appendices. Also they have a simpler title page. appendices. Also they have a simpler title page. Other document classes
Other document classes can be given. Independently of the document class, can be given. Independently of the document class, the "sphinx" package is
the "sphinx" package is always loaded in order to define Sphinx's custom always loaded in order to define Sphinx's custom LaTeX commands.
LaTeX commands.
*toctree_only* *toctree_only*
Must be ``True`` or ``False``. If true, the *startdoc* Must be ``True`` or ``False``. If true, the *startdoc* document itself is
document itself is not included in the output, only the documents not included in the output, only the documents referenced by it via TOC
referenced by it via TOC trees. With this option, you can put extra stuff trees. With this option, you can put extra stuff in the master document
in the master document that shows up in the HTML, but not the LaTeX that shows up in the HTML, but not the LaTeX output.
output.
.. versionadded:: 1.2 .. versionadded:: 1.2
In the past including your own document class required you to prepend the In the past including your own document class required you to prepend the
@ -2238,11 +2234,11 @@ These options influence manual page output.
section)``, where the items are: section)``, where the items are:
*startdocname* *startdocname*
String that specifies the relative path (without file suffix) from the String that specifies the :term:`document name` of the manual page's master
source directory to the document that is the master of the manual page. document. All documents referenced by the *startdoc* document in TOC trees
All documents referenced by the *startdoc* document in TOC trees will be will be included in the manual file. (If you want to use the default
included in the manual file. (If you want to use the default master master document for your manual pages build, use your :confval:`master_doc`
document for your manual pages build, use your :confval:`master_doc` here.) here.)
*name* *name*
Name of the manual page. This should be a short string without spaces or Name of the manual page. This should be a short string without spaces or
@ -2285,12 +2281,11 @@ These options influence Texinfo output.
are: are:
*startdocname* *startdocname*
String that specifies the relative path (without file suffix) from the String that specifies the :term:`document name` of the the Texinfo file's
source directory to the document that is the master document of the Texinfo master document. All documents referenced by the *startdoc* document in
file. All documents referenced by the *startdoc* document in TOC trees TOC trees will be included in the Texinfo file. (If you want to use the
will be included in the Texinfo file. (If you want to use the default default master document for your Texinfo build, provide your
master document for your Texinfo build, provide your :confval:`master_doc` :confval:`master_doc` here.)
here.)
*targetname* *targetname*
File name (no extension) of the Texinfo file in the output directory. File name (no extension) of the Texinfo file in the output directory.