summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJean-François B <2589111+jfbu@users.noreply.github.com>2023-03-26 20:05:07 +0200
committerJean-François B <2589111+jfbu@users.noreply.github.com>2023-03-26 23:57:04 +0200
commit7144f4924acf7737c494bec6e73874bac1ea55fb (patch)
tree5072cf943d1d4d657f4de152d9f98f97d51f764f /doc
parenta7949d42903efa64bc5f8f870d39d811e272ecda (diff)
downloadsphinx-git-7144f4924acf7737c494bec6e73874bac1ea55fb.tar.gz
LaTeX: add \sphinxnotetitle et al.
In passing I reverted some deprecation I had added at 6bf40599e to some internals of the sphinxadmonition environment, as it does not look that pressing anyhow and the redundant namings of two colors in particular may nevertheless prove useful to user \renewcommand's, as they avoid to have to refer to \spx@noticetype.
Diffstat (limited to 'doc')
-rw-r--r--doc/latex.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/latex.rst b/doc/latex.rst
index 08b2ace85..38e24a7ab 100644
--- a/doc/latex.rst
+++ b/doc/latex.rst
@@ -1464,6 +1464,16 @@ Macros
``\sphinxsamedocref``; ``\emph{#1}``
``\sphinxparam``; ``\emph{#1}``
``\sphinxoptional``; ``[#1]`` with larger brackets, see source
+ ``\sphinxnotetitle``; ``\sphinxstrong{#1}<space>``
+ ``\sphinxhinttitle``; *idem*
+ ``\sphinximportanttitle``; *idem*
+ ``\sphinxtiptitle``; *idem*
+ ``\sphinxwarningtitle``; *idem*
+ ``\sphinxcautiontitle``; *idem*
+ ``\sphinxattentiontitle``; *idem*
+ ``\sphinxdangertitle``; *idem*
+ ``\sphinxerrortitle``; *idem*
+ ``\sphinxseealsotitle``; ``\sphinxstrong{#1}\par\nopagebreak``
.. versionadded:: 1.4.5
Use of ``\sphinx`` prefixed macro names to limit possibilities of conflict
@@ -1478,6 +1488,17 @@ Macros
.. versionadded:: 6.2.0
``\sphinxparam``, ``\sphinxsamedocref``
+ .. versionadded:: 6.2.0
+ ``\sphinxnotetitle`` et al. The ``#1`` is the localized name of the
+ directive, with a final colon. Wrap it as ``\sphinxremovefinalcolon{#1}``
+ if this final colon is to be removed. Example:
+
+ .. code-block:: latex
+
+ \renewcommand\sphinxwarningtitle[1]{%
+ \underline{\textbf{\sphinxremovefinalcolon{#1}}}\par
+ }
+
- More text styling:
.. csv-table::