move (latex docs) `'geometry'` to "... don't need to be overridden"

indeed, customization will generally go via the `̀ 'sphinxsetup'`` keys
for margins or can be achieved via use of ``'passoptionstopackages'``.
Thus the key primary use would now be to remove entirely use of
``geometry`` package, which should be rarely needed.
This commit is contained in:
jfbu 2017-02-09 13:47:46 +01:00
parent eb1e9e07f6
commit f2111d8f8a

View File

@ -1730,37 +1730,6 @@ These options influence LaTeX output. See further :doc:`latex`.
contain ``\\PassOptionsToPackage{options}{foo}`` commands. Default empty. contain ``\\PassOptionsToPackage{options}{foo}`` commands. Default empty.
.. versionadded:: 1.4 .. versionadded:: 1.4
``'geometry'``
"geometry" package inclusion, the default definition is:
``'\\usepackage{geometry}'``
with an additional ``[dvipdfm]`` for Japanese documents.
The Sphinx LaTeX style file executes:
``\PassOptionsToPackage{hmargin=1in,vmargin=1in,marginpar=0.5in}{geometry}``
which can be customized via corresponding :ref:`'sphinxsetup' options
<latexsphinxsetup>`.
.. versionadded:: 1.5
.. versionchanged:: 1.5.2
``dvipdfm`` option if :confval:`latex_engine` is ``'platex'``.
.. versionadded:: 1.5.3
The :ref:`'sphinxsetup' keys for the margins
<latexsphinxsetuphmargin>`.
.. versionchanged:: 1.5.3
The location in the LaTeX file has been moved to after
``\usepackage{sphinx}`` and ``\sphinxsetup{..}``, hence also after
insertion of ``'fontpkg'`` key. This is in order to handle the paper
layout options in a special way for Japanese documents: the text
width will be set to an integer multiple of the *zenkaku* width, and
the text height to an integer multiple of the baseline. See the
:ref:`hmargin <latexsphinxsetuphmargin>` documentation for more.
``'babel'`` ``'babel'``
"babel" package inclusion, default ``'\\usepackage{babel}'`` (the "babel" package inclusion, default ``'\\usepackage{babel}'`` (the
suitable document language string is passed as class option, and suitable document language string is passed as class option, and
@ -1808,7 +1777,7 @@ These options influence LaTeX output. See further :doc:`latex`.
.. deprecated:: 1.5 .. deprecated:: 1.5
Use ``'atendofbody'`` key instead. Use ``'atendofbody'`` key instead.
* Keys that don't need be overridden unless in special cases are: * Keys that don't need to be overridden unless in special cases are:
``'maxlistdepth'`` ``'maxlistdepth'``
LaTeX allows by default at most 6 levels for nesting list and LaTeX allows by default at most 6 levels for nesting list and
@ -1845,6 +1814,36 @@ These options influence LaTeX output. See further :doc:`latex`.
.. versionchanged:: 1.5 .. versionchanged:: 1.5
Defaults to ``'\\usepackage{fontspec}'`` when Defaults to ``'\\usepackage{fontspec}'`` when
:confval:`latex_engine` is ``'xelatex'``. :confval:`latex_engine` is ``'xelatex'``.
``'geometry'``
"geometry" package inclusion, the default definition is:
``'\\usepackage{geometry}'``
with an additional ``[dvipdfm]`` for Japanese documents.
The Sphinx LaTeX style file executes:
``\PassOptionsToPackage{hmargin=1in,vmargin=1in,marginpar=0.5in}{geometry}``
which can be customized via corresponding :ref:`'sphinxsetup' options
<latexsphinxsetup>`.
.. versionadded:: 1.5
.. versionchanged:: 1.5.2
``dvipdfm`` option if :confval:`latex_engine` is ``'platex'``.
.. versionadded:: 1.5.3
The :ref:`'sphinxsetup' keys for the margins
<latexsphinxsetuphmargin>`.
.. versionchanged:: 1.5.3
The location in the LaTeX file has been moved to after
``\usepackage{sphinx}`` and ``\sphinxsetup{..}``, hence also after
insertion of ``'fontpkg'`` key. This is in order to handle the paper
layout options in a special way for Japanese documents: the text
width will be set to an integer multiple of the *zenkaku* width, and
the text height to an integer multiple of the baseline. See the
:ref:`hmargin <latexsphinxsetuphmargin>` documentation for more.
``'hyperref'`` ``'hyperref'``
"hyperref" package inclusion; also loads package "hypcap" and issues "hyperref" package inclusion; also loads package "hypcap" and issues
``\urlstyle{same}``. This is done after :file:`sphinx.sty` file is ``\urlstyle{same}``. This is done after :file:`sphinx.sty` file is