Wie erstellt man eine Tutorial-Seite in Sphinx?

Question

Ich bekomme, wie man numpy Docstrings verwendet, um die einzelnen Klassen und Methoden usw. zu dokumentieren, aber ich möchte auch eine Seite haben, die den Benutzern zeigt, wie man mein Paket in der Umgebung unserer Einrichtung benutzt (dh wie man auf das Jupyter Notebook zugreift), Wie lade ich mein Paket ein, wie richte ich die Umgebung ein und wie benutze ich es in der Praxis? Gibt es eine Möglichkeit, dies direkt in Sphinx zu tun? Oder muss ich die HTML-Seite mit einem anderen Programm erstellen?

Answer 1

Ja! Wenn Sie eine Prosadokumentation schreiben möchten, schreiben Sie diese im Allgemeinen direkt in Ihre reStructuredText-Dateien in Ihrem Sphinx-Dokumentationsverzeichnis.

So zum Beispiel, würden Sie ein installation.rst schaffen, die wie folgt aussehen könnte:

Installation 
============ 

To access the Jupyter notebook, go to `this site <https://example.com>`_ 

Dann können Sie Ihre Inhaltsverzeichnis in index.rst etwas wie folgt aussehen bearbeiten würde:

.. toctree:: 
    :maxdepth: 2 

    installation 
    some_other_preexisting_page 
    another_preexisting_page 

(Dies ist alles unter der Annahme, dass Ihre Sphinx-Setup ähnelt etwas, was sphinx-quickstart erstellt.)