diff options
| author | Roland Meister <devnull@localhost> | 2013-03-06 20:48:00 +0100 |
|---|---|---|
| committer | Roland Meister <devnull@localhost> | 2013-03-06 20:48:00 +0100 |
| commit | 77b7eced8710fe36e3cd57c8acdb3af76ad5416c (patch) | |
| tree | 8cb3be88e20081d2412de52494c4931e1bb08ccf /doc/config.rst | |
| parent | 7851459faf9579cc347f3ec82e4caaf1835e791f (diff) | |
| download | sphinx-77b7eced8710fe36e3cd57c8acdb3af76ad5416c.tar.gz | |
Add new setting epub_tocscope for epub builder.
The new setting replaces the old heuristic that was never that good.
Diffstat (limited to 'doc/config.rst')
| -rw-r--r-- | doc/config.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst index 92b53c05..35f8855a 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -916,6 +916,15 @@ the `Dublin Core metadata <http://dublincore.org/>`_. a chapter, but can be confusing because it mixes entries of differnet depth in one list. The default value is ``True``. +.. confval:: epub_tocscope + + This setting control the scope of the epub table of contents. The setting + can have the following values: + + * ``'default'`` -- include all toc entries that are not hidden (default) + * ``'includehidden'`` -- include all toc entries + + .. versionadded:: 1.2 .. confval:: epub_fix_images |