#!/usr/bin/env python3
#
# formatting.py
"""
Directives, roles and nodes for text formatting.
.. versionadded:: 0.2.0
.. extensions:: sphinx_toolbox.formatting
.. latex:vspace:: -10px
Usage
-------
.. rst:role:: iabbr
An abbreviation. If the role content contains a parenthesized explanation,
it will be treated specially: it will be shown in a tool-tip in HTML,
and output only once in LaTeX.
Unlike Sphinx's :rst:role:`abbr` role, this one shows the abbreviation in italics.
.. versionadded:: 0.2.0
:bold-title:`Example`
.. rest-example::
:iabbr:`LIFO (last-in, first-out)`
.. rst:role:: bold-title
Role for displaying a pseudo title in bold.
This is useful for breaking up Python docstrings.
.. versionadded:: 2.12.0
:bold-title:`Example`
.. rest-example::
:bold-title:`Examples:`
:bold-title:`Other Extensions`
API Reference
---------------
"""
#
# Copyright © 2020-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.
#
# Parts of the docstrings based on https://docutils.sourceforge.io/docs/howto/rst-roles.html
#
# stdlib
from typing import List, Tuple
# 3rd party
from docutils import nodes
from docutils.nodes import Node, system_message
from docutils.parsers.rst import roles
from sphinx.application import Sphinx
from sphinx.roles import Abbreviation
from sphinx.util.docutils import SphinxRole
from sphinx.writers.html5 import HTML5Translator
from sphinx.writers.latex import LaTeXTranslator
# this package
from sphinx_toolbox.utils import SphinxExtMetadata, metadata_add_version
__all__ = (
"ItalicAbbreviationNode",
"ItalicAbbreviation",
"visit_iabbr_node",
"depart_iabbr_node",
"latex_visit_iabbr_node",
"latex_depart_iabbr_node",
"setup"
)
[docs]class ItalicAbbreviationNode(nodes.abbreviation):
"""
Docutils Node to show an abbreviation in italics.
"""
[docs]class ItalicAbbreviation(Abbreviation):
"""
Docutils role to show an abbreviation in italics.
"""
[docs] def run(self) -> Tuple[List[Node], List[system_message]]:
"""
Process the content of the italic abbreviation role.
"""
options = self.options.copy()
matched = self.abbr_re.search(self.text)
if matched:
text = self.text[:matched.start()].strip()
options["explanation"] = matched.group(1)
else:
text = self.text
return [ItalicAbbreviationNode(self.rawtext, text, **options)], []
class BoldTitle(SphinxRole):
"""
Role for displaying a pseudo title in bold.
This is useful for breaking up Python docstrings.
"""
def run(self) -> Tuple[List[nodes.Node], List[nodes.system_message]]:
assert self.text is not None
node_list: List[nodes.Node] = [
nodes.raw('', r"\vspace{10px}", format="latex"),
nodes.strong(f"**{self.text}**", self.text),
]
return node_list, []
[docs]def visit_iabbr_node(translator: HTML5Translator, node: ItalicAbbreviationNode) -> None:
"""
Visit an :class:`~.ItalicAbbreviationNode`.
:param translator:
:param node: The node being visited.
"""
translator.body.append('<i class="abbreviation">')
attrs = {}
if node.hasattr("explanation"):
attrs["title"] = node["explanation"]
translator.body.append(translator.starttag(node, "abbr", '', **attrs))
[docs]def depart_iabbr_node(translator: HTML5Translator, node: ItalicAbbreviationNode) -> None:
"""
Depart an :class:`~.ItalicAbbreviationNode`.
:param translator:
:param node: The node being visited.
"""
translator.body.append("</i></abbr>")
[docs]def latex_visit_iabbr_node(translator: LaTeXTranslator, node: ItalicAbbreviationNode) -> None:
"""
Visit an :class:`~.ItalicAbbreviationNode`.
:param translator:
:param node: The node being visited.
"""
abbr = node.astext()
translator.body.append(r"\textit{\sphinxstyleabbreviation{")
# spell out the explanation once
if node.hasattr("explanation") and abbr not in translator.handled_abbrs:
translator.context.append(f'}} ({translator.encode(node["explanation"])})')
translator.handled_abbrs.add(abbr)
else:
translator.context.append('}')
[docs]def latex_depart_iabbr_node(translator: LaTeXTranslator, node: ItalicAbbreviationNode) -> None:
"""
Depart an :class:`~.ItalicAbbreviationNode`.
:param translator:
:param node: The node being visited.
"""
translator.body.append(translator.context.pop())
translator.body.append('}')
[docs]@metadata_add_version
def setup(app: Sphinx) -> SphinxExtMetadata:
"""
Setup :mod:`sphinx_toolbox.formatting`.
:param app: The Sphinx application.
"""
roles.register_local_role("iabbr", ItalicAbbreviation())
app.add_role("bold-title", BoldTitle())
app.add_node(
ItalicAbbreviationNode,
html=(visit_iabbr_node, depart_iabbr_node),
latex=(latex_visit_iabbr_node, latex_depart_iabbr_node),
)
return {"parallel_read_safe": True}