summaryrefslogtreecommitdiffstats
path: root/documentation/conf.py
diff options
context:
space:
mode:
authorPaul Barker <pbarker@konsulko.com>2020-11-13 09:54:31 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-11-13 14:36:51 +0000
commit52c71e41d464e24efa496754bd13c3b16cb7198c (patch)
tree3e6df824b06515e2fe5a5408949403a13e9455db /documentation/conf.py
parent2788b470411b405c629bfe94b8bddcc7c2c522a9 (diff)
downloadpoky-52c71e41d464e24efa496754bd13c3b16cb7198c.tar.gz
conf.py: Improve TOC and Outline depth in PDF output
The default PDF output shows only chapter headings in the table of contents and in the outline (aka PDF bookmarks). We should override these defaults to set something more suitable. With a depth of 2 for the TOC we see both section and subsection headings which is enough to get the list of classes in the reference manual and the list of topics under "Common Tasks" in the development manual. Going to a deeper level would make the TOC unwieldy but we do want to make sure we can navigate more precisely using the outline (commonly shown in a left tab in PDF viewers) so we set the depth to 5 for the outline. (From yocto-docs rev: 5db16d3b01da0a138b6413347fcf2321a1bfae08) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r--documentation/conf.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index 9a0186f352..a8df6e8f86 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -124,3 +124,8 @@ html_last_updated_fmt = '%b %d, %Y'
124 124
125# Remove the trailing 'dot' in section numbers 125# Remove the trailing 'dot' in section numbers
126html_secnumber_suffix = " " 126html_secnumber_suffix = " "
127
128latex_elements = {
129 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
130 'preamble': '\setcounter{tocdepth}{2}',
131}