Wie kann ich den `Genindex` in ein Sphinx TOC aufnehmen?

Sphinx erzeugt beim Erstellen einer Dokumentation und daher forbids to use that name for a document einen Index mit dem Namen genindex. Wie würde ich nun einen Link zu diesem Index in einem Inhaltsverzeichnis einfügen?Wie kann ich den `Genindex` in ein Sphinx TOC aufnehmen?

Ich habe dies versucht:

.. toctree:: 
    :maxdepth: 2 

    genindex 
    api 


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

* :ref:`genindex`

Während die letzte Zeile in diesem Index in dem Dokument einen Link funktioniert erstellen, wird der Build nicht die Referenz wissen, wann die TOC-Erstellung:

WARNING: toctree contains reference to nonexisting document 'genindex'

erstellen

Quelle

2016-03-26 funky-future

Wie http entfernen: // Stackoverflow. com/q/25243482/407651 – mzjn

eine Datei genindex.rst mit folgendem Inhalt:

Index 
=====

In Ihrem index.rst add:

.. toctree:: 
    :hidden: 

    genindex

Wenn Sie auch den Link und Text "Index" auf der Website und nicht nur in der linken Navigation haben wollen dann :hidden:

Quelle

2017-02-18 03:39:34

das ist komisch, die [docs] (http://www.sphinx-doc.org/en/stable/markup/toctree.html#special-names) explizit angeben, keine Datei mit zu erstellen dieser Name. –

Sie haben Recht. Das kann Probleme verursachen. Ich habe ein Projekt, bei dem die PDF-Erstellung mit rst2pdf nicht funktioniert, wenn ich den "genindex.rst" -Hack nicht entferne. –

Wie kann ich den `Genindex` in ein Sphinx TOC aufnehmen?

Antwort

Verwandte Themen