1SPHINXCONTRIB-FULLTOC(1)     sphinxcontrib-fulltoc    SPHINXCONTRIB-FULLTOC(1)
2
3
4

NAME

6       sphinxcontrib-fulltoc - sphinxcontrib-fulltoc Documentation
7
8       sphinxcontrib-fulltoc is an extension for the Sphinx documentation sys‐
9       tem that changes the HTML output to include a more  detailed  table  of
10       contents in the sidebar. By default Sphinx only shows the local headers
11       for the current page. With the extension installed,  all  of  the  page
12       titles  are  included,  and  the local headers for the current page are
13       also included in the appropriate place within the document.
14

INSTALLING

16   Basic Installation
17       1. Install the package along with Sphinx.
18
19          There are two ways to install the extension. Using pip:
20
21             $ pip install sphinxcontrib-fulltoc
22
23          or from the source tree:
24
25             $ python setup.py install
26
27       2. Add the extension to the list in your conf.py settings file for each
28          project where you want to use it:
29
30             # conf.py
31             ...
32             extensions = ['sphinxcontrib.fulltoc']
33             ...
34
35       3. Rebuild all of the HTML output for your project.
36
37   Advanced Use
38       If you have customized the theme for your documentation, and especially
39       if you have modified the way sidebars are applied, you may need to take
40       some additional configuration steps.
41
42   localtoc.html
43       The  localtoc.html  template is used to insert the table of contents in
44       the sidebar of an HTML page. By default it looks like:
45
46          {%- if display_toc %}
47            <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
48            {{ toc }}
49          {%- endif %}
50
51       sphinxcontrib-fulltoc forces display_toc to be set to True and replaces
52       the toc variable with the full table of contents. If your localtoc.html
53       document has been changed, you may need to update it to include {{  toc
54       }}, or restore the template to the default.
55
56   The Full Full TOC
57       If  you  do not want the table of contents collapsed to ignore subhead‐
58       ings on other pages, you can replace the  {{  toc  }}  line  in  local‐
59       toc.html with a call to toctree(), which accepts two parameters.
60
61       toctree(collapse=True)
62              Generate a table of contents relative to the current document.
63
64              Parameters
65                     collapse (bool) – Controls whether or not remote parts of
66                     the tree are shown. Setting to True only  shows  internal
67                     links  on the current page. Setting to False shows inter‐
68                     nal links on all pages.
69
70              Returns
71                     HTML text of the table of contents
72

FOR DEVELOPERS

74       If  you  would  like  to  contribute  to  sphinxcontrib-fulltoc,  these
75       instructions  should  help  you get started.  Patches, bug reports, and
76       feature requests are all welcome through the  GitHub  site.   Contribu‐
77       tions  in  the form of patches or pull requests are easier to integrate
78       and will receive priority attention.
79
80   Building Documentation
81       The documentation for sphinxcontrib-fulltoc is written in reStructured‐
82       Text and converted to HTML using Sphinx, as you might expect. The build
83       itself is driven by setuptools. You will need the following packages in
84       order to build the docs:
85
86       · Sphinx
87
88       · docutils
89
90       · sphinxcontrib-fulltoc
91
92       Once  all  of  the tools are installed into a virtualenv using pip, run
93       python setup.py build_sphinx to generate the HTML version of the  docu‐
94       mentation:
95
96          $ python setup.py build_sphinx
97
98       The  output version of the documentation ends up in ./build/sphinx/html
99       inside your sandbox.
100

HISTORY

102       1.0
103
104          · First public release
105
106       0.1
107
108          · Internal version
109

AUTHOR

111       Doug Hellmann
112

114       2019, Doug Hellmann
115
116
117
118
1191.2                              Jul 26, 2019         SPHINXCONTRIB-FULLTOC(1)
Impressum