IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

minor update to latex.rst

Browse Source
This commit is contained in:
jfbu 2016-10-30 00:08:17 +02:00
parent e70746e8da
commit aff72931fc
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/latex.rst
View File

@ -126,6 +126,12 @@ If non-empty, it will be passed as argument to the ``\sphinxsetup`` command::
Here are the currently available options together with their default values. Here are the currently available options together with their default values.
.. caution::
These options correspond to what has been so far the default LaTeX
rendering by Sphinx; if in future Sphinx offers various *themes* for LaTeX,
the interface may change.
``verbatimwithframe`` ``verbatimwithframe``
default ``true``. Boolean to specify if :rst:dir:`code-block`\ s and literal default ``true``. Boolean to specify if :rst:dir:`code-block`\ s and literal
includes are framed. Setting it to ``false`` does not deactivate use of includes are framed. Setting it to ``false`` does not deactivate use of
@ -309,15 +315,8 @@ Here are the currently available options together with their default values.
``HeaderFamily`` ``HeaderFamily``
default ``\sffamily\bfseries``. Sets the font used by headings. default ``\sffamily\bfseries``. Sets the font used by headings.
As seen above, key values may even be used for LaTeX commands. But don't
.. caution:: forget to double the backslashes if not using "raw" Python strings.
These options correspond to what has been so far the default LaTeX rendering by Sphinx;
if in future Sphinx offers various *themes* for LaTeX, the interface may change.
In the future, possibly more keys will be made available. As seen above, they
may even be used for LaTeX commands. Don't forget to double the backslashes if not using
"raw" Python strings.
The LaTeX environments defined by Sphinx The LaTeX environments defined by Sphinx
---------------------------------------- ----------------------------------------
@ -421,7 +420,6 @@ Let us now list some macros from the package file
- the list is not exhaustive: refer to :file:`sphinx.sty` for more. - the list is not exhaustive: refer to :file:`sphinx.sty` for more.
.. hint:: .. hint::
As an experimental feature, Sphinx can use user-defined template file for As an experimental feature, Sphinx can use user-defined template file for