Lage von Sphinx Quellen für meine Notizen

StackOverflow https://stackoverflow.com/questions/1690757

  •  18-09-2019
  •  | 
  •  

Frage

Wie kann man die Sphinx Warnung am Boden fixieren?

Ich versuche, meine Python Notizen in Sphinx zu haben. Ich habe meine Notizen in separaten Dateien auf der gleichen Verzeichnisebene wie die index.rst .

Ich erhalte die folgenden Warnungen nach dem Bau HTML

Die Warnung 

/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree

in

Die komplette Meldung beim Erstellen 

sudo sphinx-build -b html ./ _build/html
Running Sphinx v0.6.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 1 added, 2 changed, 0 removed
reading sources... [100%] trig_functions
/home/heo/S_codes/databooklet.rst:1: (WARNING/2) malformed hyperlink target.
/home/heo/S_codes/index.rst:11: (ERROR/3) Error in "toctree" directive:
invalid option block.

.. toctree::
   :numbered:
   :glob:
   *
   databooklet.rst
   trig_functions.rst


/home/heo/S_codes/trig_functions.rst:11: (ERROR/3) Unexpected indentation.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/heo/S_codes/databooklet.rst:: WARNING: document isn't included in any toctree
/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] trig_functions
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 6 warnings.
War es hilfreich?

Lösung

Sind Sie sich bewusst von Sphinx in der Dokumentation? http://sphinx.pocoo.org/contents.html

Insbesondere lesen über die toctree Direktive: http://sphinx.pocoo.org/concepts.html

Sie können so viele Dateien wie Sie wollen. Via toctree können Sie ein einzelnes Dokument aus vielen Teilen erstellen.

Bitte eigentlich lesen folgt aus: http: // Sphinx. pocoo.org/concepts.html#document-names

  

Da die reST Quelldateien können   verschiedene Erweiterungen (einige Leute wie   .txt, einige wie .rst - die Erweiterung   mit source_suffix konfiguriert werden)   und verschiedene Betriebssysteme haben unterschiedlichen Pfad   Separatoren, Sphinx abstrahiert sie: alle   „Dokumentnamen“ sind in Bezug auf die   Quellverzeichnis, die Erweiterung   gestrippt und Pfadtrenn sind   umgewandelt Schrägstriche. Alle Werte,   Parameter und ähnliches unter Bezugnahme auf   „Dokumente“ erwarten, ein solches Dokument   Name.

     

Beispiele für Dokumentnamen sind index,   library/zipfile oder   reference/datamodel/types. Beachten Sie, dass   es gibt keinen Schrägstrich.

Da Sie mit * globbed, brauchen Sie nicht Ihre Dateien aufzulisten.

Wenn Sie Ihre Dateien auflisten möchten, benutzen Sie bitte wirklich lesen und folgen die oben genannten Regeln.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top