diff options
| author | Erik Bernoth <erik.bernoth@gmail.com> | 2013-09-23 13:54:18 +0200 |
|---|---|---|
| committer | Erik Bernoth <erik.bernoth@gmail.com> | 2013-09-23 13:54:18 +0200 |
| commit | 496e04d2968bcea4b9afb4f7833d039ce0e24be1 (patch) | |
| tree | 65345205b4933cbb601b6c30e491dddd1e3502ed /doc | |
| parent | e794c3cfd7ce600c288c110d639f6e8966364c38 (diff) | |
| download | sphinx-496e04d2968bcea4b9afb4f7833d039ce0e24be1.tar.gz | |
Note in the documentation, that prepending "sphinx" is not necessary anymore.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst index 24334f36..5f938ea6 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -999,11 +999,17 @@ These options influence LaTeX output. "sphinx" package in order to define Sphinx' custom LaTeX commands. "howto" documents will not get appendices. Also, howtos will have a simpler title page. + * *toctree_only*: Must be ``True`` or ``False``. If ``True``, the *startdoc* 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 in the master document that shows up in the HTML, but not the LaTeX output. + .. versionadded:: 1.2 + In the past including your own document class required you to prepend the + document class name with the string "sphinx". This is not necessary + anymore. + .. versionadded:: 0.3 The 6th item ``toctree_only``. Tuples with 5 items are still accepted. |