Skip to content

Commit

Permalink
LaTeX: add some documentation for container support (sphinx-doc#9166)
Browse files Browse the repository at this point in the history
  • Loading branch information
jfbu committed Jul 19, 2021
1 parent de37cbc commit af5363c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/latex.rst
Expand Up @@ -1151,6 +1151,20 @@ Miscellany
Formerly, use of *fncychap* with other styles than ``Bjarne`` was
dysfunctional.

- Docutils :dudir:`container` directives are supported in LaTeX output: to
let a container class with name ``foo`` influence the final PDF via LaTeX,
it is only needed to define in the preamble an environment
``sphinxclassfoo``. A simple example would be:

.. code-block:: latex

\newenvironment{sphinxclassred}{\color{red}}{}

Currently the class names must contain only ascii characters and avoid
characters special to LaTeX such as ``\``.

.. versionadded:: 4.1.0

.. hint::

As an experimental feature, Sphinx can use user-defined template file for
Expand Down

0 comments on commit af5363c

Please sign in to comment.