diff options
| author | Clément Pit-Claudel | 2018-09-04 18:11:40 -0400 |
|---|---|---|
| committer | Théo Zimmermann | 2018-09-20 10:12:55 +0200 |
| commit | ad7dda30d651f259304a2efdcc84519ae6542bb7 (patch) | |
| tree | 8008cd74f6850a5ec2e15d562db43bca5cdf302e | |
| parent | 47bd6c3de6e8e2e8cdaf049ba95934ad4d0af4f7 (diff) | |
[doc] Explain why zebibliography needs to be separate and oddly-named
| -rw-r--r-- | doc/sphinx/zebibliography.rst | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/sphinx/zebibliography.rst b/doc/sphinx/zebibliography.rst index 0000caa301..756edd5482 100644 --- a/doc/sphinx/zebibliography.rst +++ b/doc/sphinx/zebibliography.rst @@ -1,8 +1,17 @@ +.. There are multiple issues with sphinxcontrib-bibtex that we have to work around: + - The list of cited entries is computed right after encountering + `.. bibliography`, so the file containing that command has to come last + alphabetically: + https://sphinxcontrib-bibtex.readthedocs.io/en/latest/usage.html#unresolved-citations-across-documents + - `.. bibliography::` puts the bibliography on its own page with its own + title in LaTeX, but includes it inline without a title in HTML: + https://sphinxcontrib-bibtex.readthedocs.io/en/latest/usage.html#mismatch-between-output-of-html-and-latex-backends + .. _bibliography: -============ -Bibliography -============ +============== + Bibliography +============== .. bibliography:: biblio.bib :cited: |