如何在「獅身人面像目錄」中包含「genindex」？

2016-03-26 38 views 3 likes

構建文檔時，Sphinx生成索引genindex，因此生成forbids to use that name for a document。現在，我將如何在目錄中包含指向該索引的鏈接？如何在「獅身人面像目錄」中包含「genindex」？

我已經試過這樣：

.. toctree:: 
    :maxdepth: 2 

    genindex 
    api 


Indices and tables 
================== 

* :ref:`genindex`

雖然最後一行將創建一個文檔中的鏈接到該索引，創建TOC時生成不知道參考：

WARNING: toctree contains reference to nonexisting document 'genindex'

與http：//計算器。 com/q/25243482/407651 – mzjn

回答

與以下內容創建一個文件genindex.rst：

Index 
=====

在你index.rst地址：

.. toctree:: 
    :hidden: 

    genindex

如果你也想擁有網站上的鏈接和文本「指數」不僅在左側導航然後取出:hidden:

2017-02-18 03:39:34

這很有趣，[docs]（http://www.sphinx-doc.org/en/stable/markup/toctree.html#special-names）顯式聲明不創建文件那個名字。 –

你說得對。這可能會導致問題。我有一個項目，其中用rst2pdf創建的PDF不起作用，除非我不刪除「genindex.rst」 - 黑客。 –

相關問題