「genindex」をSphinx目次に含めるにはどうすればいいですか？

ドキュメント作成時にgenindexというインデックスが作成されるため、forbids to use that name for a documentとなります。今、そのインデックスへのリンクを目次にどのように含めるのですか？私はこれを試してみた「genindex」をSphinx目次に含めるにはどうすればいいですか？

：最後の行は、文書内のそのインデックスへのリンクを作成していますがTOCを作成するときに

.. toctree:: 
    :maxdepth: 2 

    genindex 
    api 


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

* :ref:`genindex`

、ビルドは参照を知らない：

WARNING: toctree contains reference to nonexisting document 'genindex'

出典

2016-03-26 funky-future

削除：//のstackoverflowを。面白いことに、[docs]（http://www.sphinx-doc.org/en/stable/markup/toctree.html#special-names）は、ファイルを作成しないように明示的に述べています。com/q/25243482/407651 – mzjn

次の内容のファイルを作成しますgenindex.rst：

Index 
=====

をあなたの01で追加：

.. toctree:: 
    :hidden: 

    genindex

あなたはまた、サイト上だけではなく、左側のナビゲーションでのリンクやテキスト「インデックス」を持つようにしたい場合は、HTTPと同じ:hidden:

出典

2017-02-18 03:39:34

その名前。 –

あなたは正しいです。それは問題を引き起こす可能性があります。私は "genindex.rst" -Hackを削除しない限り、rst2pdfでPDF Creationが動作しないプロジェクトが1つあります。 –

「genindex」をSphinx目次に含めるにはどうすればいいですか？

答えて

関連する問題