.\" Man page generated from reStructuredText.
.
.TH "SPHINXCONTRIB-FULLTOC" "1" "Sep 20, 2018" "1.2" "sphinxcontrib-fulltoc"
.SH NAME
sphinxcontrib-fulltoc \- sphinxcontrib-fulltoc Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
sphinxcontrib\-fulltoc is an extension for the \fI\%Sphinx\fP documentation
system that changes the HTML output to include a more detailed table
of contents in the sidebar. By default Sphinx only shows the local
headers for the current page. With the extension installed, all of the
page titles are included, and the local headers for the current page
are also included in the appropriate place within the document.
.SH INSTALLING
.SS Basic Installation
.INDENT 0.0
.IP 1. 3
Install the package along with Sphinx.
.sp
There are two ways to install the extension. Using pip:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
$ pip install sphinxcontrib\-fulltoc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from the source tree:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
$ python setup.py install
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Add the extension to the list in your \fBconf.py\fP settings file for
each project where you want to use it:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
# conf.py
\&...
extensions = [\(aqsphinxcontrib.fulltoc\(aq]
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Rebuild all of the HTML output for your project.
.UNINDENT
.SS Advanced Use
.sp
If you have customized the theme for your documentation, and
especially if you have modified the way sidebars are applied, you may
need to take some additional configuration steps.
.SS localtoc.html
.sp
The \fBlocaltoc.html\fP template is used to insert the table of contents
in the sidebar of an HTML page. By default it looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{%\- if display_toc %}
  <h3><a href="{{ pathto(master_doc) }}">{{ _(\(aqTable Of Contents\(aq) }}</a></h3>
  {{ toc }}
{%\- endif %}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBsphinxcontrib\-fulltoc\fP forces \fBdisplay_toc\fP to be set to True and
replaces the \fBtoc\fP variable with the full table of contents. If your
\fBlocaltoc.html\fP document has been changed, you may need to update it
to include \fB{{ toc }}\fP, or restore the template to the default.
.SS The \fIFull\fP Full TOC
.sp
If you do not want the table of contents collapsed to ignore
subheadings on other pages, you can replace the \fB{{ toc }}\fP line in
\fBlocaltoc.html\fP with a call to \fBtoctree()\fP, which accepts two
parameters.
.INDENT 0.0
.TP
.B toctree(collapse=True)
Generate a table of contents relative to the current document.
.INDENT 7.0
.TP
.B Parameters
\fBcollapse\fP (\fIbool\fP) – Controls whether or not remote parts of the tree
are shown. Setting to True only shows internal
links on the current page. Setting to False
shows internal links on all pages.
.TP
.B Returns
HTML text of the table of contents
.UNINDENT
.UNINDENT
.SH FOR DEVELOPERS
.sp
If you would like to contribute to sphinxcontrib\-fulltoc, these
instructions should help you get started.  Patches, bug reports, and
feature requests are all welcome through the \fI\%GitHub site\fP\&.  Contributions
in the form of patches or pull requests are easier to integrate and
will receive priority attention.
.SS Building Documentation
.sp
The documentation for sphinxcontrib\-fulltoc is written in
reStructuredText and converted to HTML using Sphinx, as you might
expect. The build itself is driven by setuptools. You will need the
following packages in order to build the docs:
.INDENT 0.0
.IP \(bu 2
Sphinx
.IP \(bu 2
docutils
.IP \(bu 2
sphinxcontrib\-fulltoc
.UNINDENT
.sp
Once all of the tools are installed into a virtualenv using pip, run
\fBpython setup.py build_sphinx\fP to generate the HTML version of the
documentation:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ python setup.py build_sphinx
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The output version of the documentation ends up in
\fB\&./build/sphinx/html\fP inside your sandbox.
.SH HISTORY
.sp
1.0
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
First public release
.UNINDENT
.UNINDENT
.UNINDENT
.sp
0.1
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Internal version
.UNINDENT
.UNINDENT
.UNINDENT
.SH AUTHOR
Doug Hellmann
.SH COPYRIGHT
2012, Doug Hellmann
.\" Generated by docutils manpage writer.
.