IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix config.rst description of `latex_documents` docclass element

Browse Source
This commit is contained in:
jfbu
2016-10-17 09:46:38 +02:00
parent 53ea1cb280
commit daee1fc51d
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/config.rst
+7 -5
View File
@@ -1562,11 +1562,13 @@ These options influence LaTeX output. See further :doc:`latex`.
* *author*: Author for the LaTeX document. The same LaTeX markup caveat as
for *title* applies. Use ``\and`` to separate multiple authors, as in:
``'John \and Sarah'``.
* *documentclass*: Normally, one of ``'manual'`` or ``'howto'`` (provided by
Sphinx). Other document classes can be given, but they must include the
"sphinx" package in order to define Sphinx's custom LaTeX commands. "howto"
documents will not get appendices. Also, howtos will have a simpler title
page.
* *documentclass*: Normally, one of ``'manual'`` or ``'howto'`` (provided
by Sphinx and based on ``'report'``, resp. ``'article'``; Japanese
documents use ``'jsbook'``, resp. ``'jreport'``.) "howto" (non-Japanese)
documents will not get appendices. Also they have a simpler title page.
Other document classes can be given. Independently of the document class,
the "sphinx" package is always loaded in order to define Sphinx's custom
LaTeX commands.
* *toctree_only*: Must be ``True`` or ``False``. If true, the *startdoc*
document itself is not included in the output, only the documents