#!/usr/bin/env python3
#
# toc.py
"""
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.
.. versionadded:: 2.1.0
.. versionchanged:: 3.0.0 Moved from :mod:`sphinx_toolbox.tweaks.latex_toc`.
.. latex:clearpage::
.. extensions:: sphinx_toolbox.latex.toc
-----
""" # noqa: D400
#
# Copyright © 2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
from typing import List
# 3rd party
import sphinx.directives.other
import sphinx.writers.latex
from docutils import nodes
from sphinx.application import Sphinx
# this package
from sphinx_toolbox.latex import use_package
from sphinx_toolbox.utils import Config, SphinxExtMetadata, metadata_add_version
__all__ = ("setup", )
nest_bookmark_level_part = "\\bookmarksetupnext{{level=part}}\n"
class latex_toc(nodes.raw):
pass
class LaTeXTranslator(sphinx.writers.latex.LaTeXTranslator):
def generate_indices(self) -> str:
super_output = super().generate_indices()
if not super_output:
return nest_bookmark_level_part
return '\n'.join([
nest_bookmark_level_part,
*super_output.splitlines(),
'',
nest_bookmark_level_part,
])
def visit_latex_toc(self, node: latex_toc) -> None:
if not self.is_inline(node):
self.body.append('\n')
if "latex" in node.get("format", '').split():
self.body.append(f"\\{self.sectionnames[self.sectionlevel]}{{{node.astext()}}}")
if not self.is_inline(node):
self.body.append('\n')
raise nodes.SkipNode
def depart_latex_toc(self, node: latex_toc) -> None: # pragma: no cover
pass
class LatexTocTreeDirective(sphinx.directives.other.TocTree):
def run(self) -> List[nodes.Node]:
"""
Process the content of the directive.
"""
assert self.env.app.builder is not None
output: List[nodes.Node] = []
caption = self.options.get("caption")
if (
caption is not None and "hidden" not in self.options
and self.env.app.builder.format.lower() == "latex"
and self.env.docname == self.env.config.master_doc
):
output.append(latex_toc(text=caption, format="latex"))
output.extend(super().run())
return output
def configure(app: Sphinx, config: Config) -> None:
"""
Configure :mod:`sphinx_toolbox.latex.toc`.
:param app: The Sphinx application.
:param config:
"""
use_package("bookmark", config)
def purge_outdated(app: Sphinx, env, added, changed, removed) -> List[str]: # noqa: MAN001
return [env.config.master_doc]
[docs]@metadata_add_version
def setup(app: Sphinx) -> SphinxExtMetadata:
"""
Setup :mod:`sphinx_toolbox.tweaks.latex_toc`.
:param app: The Sphinx application.
"""
app.connect("env-get-outdated", purge_outdated)
app.connect("config-inited", configure)
app.add_directive("toctree", LatexTocTreeDirective, override=True)
app.set_translator("latex", LaTeXTranslator, override=True)
return {"parallel_read_safe": True}