Skip to content

Commit

Permalink
Document issue with citation references in toctrees (see #282).
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmtroffaes committed Feb 8, 2022
1 parent 76075fc commit 041e941
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -998,6 +998,17 @@ LaTeX output, you can add the following to your LaTeX preamble:
\usepackage{etoolbox}
\patchcmd{\thebibliography}{\section*{\refname}}{}{}{}

Citation References Not Rendered In TocTree Directives
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When a document title has a citation reference in it,
the toctree directive will simply take the target of the reference
for rendering in the table of contents, rather than the fully rendered
reference.

This appears to be a limitation of the toctree directive.
No workaround is currently known.

Import errors after using setup.py install
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 041e941

Please sign in to comment.