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

Merge pull request #8851 from jfbu/latex_enhance_docs_about_index

Browse Source 
LaTeX: improve docs of 'printindex' and 'makeindex'
This commit is contained in:
Jean-François B 2021-02-09 16:16:26 +01:00 committed by GitHub
commit 1c08467040
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -120,6 +120,8 @@ Bugs fixed
specified specified
* #7576: LaTeX with French babel and memoir crash: "Illegal parameter number * #7576: LaTeX with French babel and memoir crash: "Illegal parameter number
in definition of ``\FNH@prefntext``" in definition of ``\FNH@prefntext``"
* #8055: LaTeX (docs): A potential display bug with the LaTeX generation step
in Sphinx (how to generate one-column index)
* #8072: LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX * #8072: LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX
* #8214: LaTeX: The :rst:role:`index` role and the glossary generate duplicate * #8214: LaTeX: The :rst:role:`index` role and the glossary generate duplicate
entries in the LaTeX index (if both used for same term) entries in the LaTeX index (if both used for same term)

18
doc/latex.rst
View File

@ -497,11 +497,22 @@ Keys that don't need to be overridden unless in special cases are:
.. versionchanged:: 1.6 .. versionchanged:: 1.6
Remove unneeded ``{}`` after ``\\hrule``. Remove unneeded ``{}`` after ``\\hrule``.
``'makeindex'``
"makeindex" call, the last thing before ``\begin{document}``. With
``'\\usepackage[columns=1]{idxlayout}\\makeindex'`` the index will use
only one column. You may have to install ``idxlayout`` LaTeX package.
Default: ``'\\makeindex'``
``'printindex'`` ``'printindex'``
"printindex" call, the last thing in the file. Override if you want to "printindex" call, the last thing in the file. Override if you want to
generate the index differently or append some content after the index. For generate the index differently, append some content after the index, or
example ``'\\footnotesize\\raggedright\\printindex'`` is advisable when the change the font. As LaTeX uses two-column mode for the index it is
index is full of long entries. often advisable to set this key to
``'\\footnotesize\\raggedright\\printindex'``. Or, to obtain a one-column
index, use ``'\\def\\twocolumn[#1]{#1}\\printindex'`` (this trick may fail
if using a custom document class; then try the ``idxlayout`` approach
described in the documentation of the ``'makeindex'`` key).
Default: ``'\\printindex'`` Default: ``'\\printindex'``
@ -527,7 +538,6 @@ Keys that are set by other options and therefore should not be overridden are:
``'title'`` ``'title'``
``'release'`` ``'release'``
``'author'`` ``'author'``
``'makeindex'``
.. _latexsphinxsetup: .. _latexsphinxsetup: