Skip to content

Commit b88713e

Browse files
committed
Update LaTeX docs
1 parent 55170d0 commit b88713e

File tree

1 file changed

+56
-33
lines changed

1 file changed

+56
-33
lines changed

doc/latex.rst

Lines changed: 56 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1331,44 +1331,66 @@ Macros
13311331

13321332
- Text styling commands:
13331333

1334-
- ``\sphinxstrong``,
1335-
- ``\sphinxcode``,
1336-
- ``\sphinxbfcode``,
1337-
- ``\sphinxemail``,
1338-
- ``\sphinxtablecontinued``,
1339-
- ``\sphinxtitleref``,
1340-
- ``\sphinxmenuselection``,
1341-
- ``\sphinxguilabel``,
1342-
- ``\sphinxkeyboard``,
1343-
- ``\sphinxaccelerator``,
1344-
- ``\sphinxcrossref``,
1345-
- ``\sphinxtermref``,
1346-
- ``\sphinxsamedocref``,
1347-
- ``\sphinxparam``,
1348-
- ``\sphinxoptional``.
1334+
.. csv-table::
1335+
:header: Name, ``maps argument #1 to:``
1336+
:align: left
1337+
:delim: ;
1338+
1339+
``\sphinxstrong``; ``\textbf{#1}``
1340+
``\sphinxcode``; ``\texttt{#1}``
1341+
``\sphinxbfcode``; ``\textbf{\sphinxcode{#1}}``
1342+
``\sphinxemail``; ``\textsf{#1}``
1343+
``\sphinxtablecontinued``; ``\textsf{#1}``
1344+
``\sphinxtitleref``; ``\emph{#1}``
1345+
``\sphinxmenuselection``; ``\emph{#1}``
1346+
``\sphinxguilabel``; ``\emph{#1}``
1347+
``\sphinxkeyboard``; ``\sphinxcode{#1}``
1348+
``\sphinxaccelerator``; ``\underline{#1}``
1349+
``\sphinxcrossref``; ``\emph{#1}``
1350+
``\sphinxtermref``; ``\emph{#1}``
1351+
``\sphinxsamedocref``; ``\emph{#1}``
1352+
``\sphinxparam``; ``\emph{#1}``
1353+
``\sphinxoptional``; ``[#1]`` with larger brackets, see source
13491354

13501355
.. versionadded:: 1.4.5
13511356
Use of ``\sphinx`` prefixed macro names to limit possibilities of conflict
13521357
with LaTeX packages.
13531358

1359+
.. versionadded:: 1.8
1360+
``\sphinxguilabel``
1361+
1362+
.. versionadded:: 3.0
1363+
``\sphinxkeyboard``
1364+
1365+
.. versionadded:: 6.2.0
1366+
``\sphinxparam``, ``\sphinxsamedocref``
1367+
13541368
- More text styling:
13551369

1356-
- ``\sphinxstyleindexentry``,
1357-
- ``\sphinxstyleindexextra``,
1358-
- ``\sphinxstyleindexpageref``,
1359-
- ``\sphinxstyletopictitle``,
1360-
- ``\sphinxstylesidebartitle``,
1361-
- ``\sphinxstyleothertitle``,
1362-
- ``\sphinxstylesidebarsubtitle``,
1363-
- ``\sphinxstyletheadfamily``,
1364-
- ``\sphinxstyleemphasis``,
1365-
- ``\sphinxstyleliteralemphasis``,
1366-
- ``\sphinxstylestrong``,
1367-
- ``\sphinxstyleliteralstrong``,
1368-
- ``\sphinxstyleabbreviation``,
1369-
- ``\sphinxstyleliteralintitle``,
1370-
- ``\sphinxstylecodecontinued``,
1371-
- ``\sphinxstylecodecontinues``.
1370+
.. csv-table::
1371+
:header: Name, ``maps argument #1 to:``
1372+
:align: left
1373+
:delim: ;
1374+
1375+
``\sphinxstyleindexentry``; ``\texttt{#1}``
1376+
``\sphinxstyleindexextra``; ``(\emph{#1})`` (with a space upfront)
1377+
``\sphinxstyleindexpageref``; ``, \pageref{#1}``
1378+
``\sphinxstyleindexpagemain``; ``\textbf{#1}``
1379+
``\sphinxstyleindexlettergroup``; ``{\Large\sffamily#1}\nopagebreak\vspace{1mm}``
1380+
``\sphinxstyleindexlettergroupDefault``; check source, too long for here
1381+
``\sphinxstyletopictitle``; ``\textbf{#1}\par\medskip``
1382+
``\sphinxstylesidebartitle``; ``\textbf{#1}\par\medskip``
1383+
``\sphinxstyleothertitle``; ``\textbf{#1}``
1384+
``\sphinxstylesidebarsubtitle``; ``~\\\textbf{#1} \smallskip``
1385+
``\sphinxstyletheadfamily``; ``\sffamily`` (*this one has no argument*)
1386+
``\sphinxstyleemphasis``; ``\emph{#1}``
1387+
``\sphinxstyleliteralemphasis``; ``\emph{\sphinxcode{#1}}``
1388+
``\sphinxstylestrong``; ``\textbf{#1}``
1389+
``\sphinxstyleliteralstrong``; ``\sphinxbfcode{#1}``
1390+
``\sphinxstyleabbreviation``; ``\textsc{#1}``
1391+
``\sphinxstyleliteralintitle``; ``\sphinxcode{#1}``
1392+
``\sphinxstylecodecontinued``; ``{\footnotesize(#1)}}``
1393+
``\sphinxstylecodecontinues``; ``{\footnotesize(#1)}}``
13721394

13731395
.. versionadded:: 1.5
13741396
These macros were formerly hard-coded as non customizable ``\texttt``,
@@ -1381,8 +1403,9 @@ Macros
13811403
.. versionadded:: 1.6.3
13821404
``\sphinxstylecodecontinued`` and ``\sphinxstylecodecontinues``.
13831405

1384-
.. versionadded:: 3.0
1385-
``\sphinxkeyboard``
1406+
.. versionadded:: 1.8
1407+
``\sphinxstyleindexlettergroup``, ``\sphinxstyleindexlettergroupDefault``.
1408+
13861409

13871410
- ``\sphinxtableofcontents``: A wrapper (defined differently in
13881411
:file:`sphinxhowto.cls` and in :file:`sphinxmanual.cls`) of standard

0 commit comments

Comments
 (0)