tweaks.latex_toc

Adjusts the default LaTeX output as follows:

  • The captions from toctree directives are converted into document parts.

  • The PDF outline has the correct hierarchy, including having the indices as top-level elements.

New in version 2.1.0.

Enable sphinx_toolbox.tweaks.latex_toc by adding the following to the extensions variable in your conf.py:

extensions = [
    ...
    'sphinx_toolbox.tweaks.latex_toc',
    ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .

Changed in version 3.0.0: The functionality has moved to sphinx_toolbox.latex.toc. Please use that extension instead.

Functions:

configure(app, config)

Configure sphinx_toolbox.tweaks.latex_toc.

setup(app)

Setup sphinx_toolbox.tweaks.latex_toc.
configure(app, config)[source]

Configure sphinx_toolbox.tweaks.latex_toc.

Parameters:

  • app (Sphinx) – The Sphinx application.

  • config (Config)

setup(app)[source]

Setup sphinx_toolbox.tweaks.latex_toc.

Parameters:

app (Sphinx) – The Sphinx application.

Return type:

SphinxExtMetadata