2017-08-30 42 views
1

我正在寫一本書在獅身人面像(不是所有與Python相關的)。我還有一些術語出現在我希望在pdf末尾列出的文本中。我想要的是由Latex提供的index如何在獅身人面像中創建一個自動的單詞列表

我知道在獅身人面像glossary指令,但它顯然不能執行我想要的。例如,有幾個術語甚至沒有定義,但我想在文檔結尾處鏈接到它們。事情是這樣的:

At page 1: 

    Mammal is a type of animal, we all love them... 

At page 17: 

    Berries are fruits, we all love them... 

At the end of the book: 

    Index 
    berry, 17 
    mammal, 1 

我讀過關於獅身人面像文檔中的index作用,here。 對於我的問題來說,這看起來很完美,但不清楚如何在最後創建所有術語的索引。

是否有一個命令列出創建的所有條款使用

.. index: mammal 

整個文本?還是有另一個指令可以完成工作?

+1

我不知道任何可以運行的命令,除了'make '以外。這是一個[使用'make html']的Sphinx文檔輸出示例(http://www.sphinx-doc.org/en/stable/genindex.html)。 Sphinx自動爲任何構建器生成索引。索引中的條目根據域以及reStructuredText標記中的任何手工條目生成。「index:」爲塊,「:index:」爲內聯。 –

+1

該索引在LaTeX中的工作方式類似。 Sphinx生成一個包含所有索引內容的獨立HTML頁面。你可以有簡單的,雙重的和三重索引條目。獅身人面像會將它們分組給你。這是一個[示例輸出](http://ghdl.readthedocs.io/en/latest/genindex.html)。有些域名將創建自己的索引。 – Paebbels

回答

1

這些評論足以讓我弄清楚。

索引自動生成在html中,但必須在文件genindex.html中找到,該文件由於其他原因隱藏在我的機器中。

對於pdf輸出,索引必須分開編譯。

所以,在獅身人面像沒有額外的命令,一切都是自動的。

+0

通常,索引通過HTML頁面鏈接進行鏈接,但有一個技巧可以將索引鏈接到導航欄中。您需要創建'genindex.rst',它可以在'toctree'指令中列出。當導航被寫入並且所有內容都被解析時,Sphinx將會用索引數據庫的輸出覆蓋genindex.html。 – Paebbels