Einstieg in Sphinx

[Mungo1981]

Hallo,
Ich weis ich bin immer noch hier für mein kleines Programm
um wieder in Python rein zu kommen.
Jetzt wäre ich soweit:

• Meine GUI Funktioniert

• Mein Code sollte den Coding Regel folgen

• Doc-Strings usw natürlich

Und jetzt kommt der große Moment ...
... wo der Programmierer mal aufs Kloh muss
... der Frosch über die Tastatur hüpft
NEIN:
Wo die Documentation in Sphinx weiter verarbeitet werden soll

Da ich aber Überhaupt keine Ahnung hab wie das geht ....
.... die Frage:

Hat jemand eine gute leicht Verständliche Einführung in Sphinx

Mungo1981

[__blackjack__]

@Mungo1981: Die Sphinx-Dokumentation‽

[Mungo1981]

Wenn du so etwas hast gerne.
Hab schon eine Anleitung gefunden.
Nur ich verstehe leider das Aufsetzen einer:
index.rst

Ich verstehe leider nicht welche Datei in welchen Ordner
Und wie ich dann die Dateien in dieser Datei einbinde.

Und vielleicht bräuchte Ich noch Informationen zum Richtigen Formatieren
der:

• Comments

• Doc-Strings

[__blackjack__]

@Mungo1981: Wenn ich was habe? Meine Antwort war: Die Sphinx-Dokumentation! (+ ? weil ich bei der Antwort die Stimme nach oben gezogen hätte wie bei einer Frage im Sinne von, das ist doch wohl offensichtlich wie bei jedem Projekt der erste Anlaufpunkt.)

Schau Dir doch einfach an in welchen Ordnern die Dateien liegen die in der Sphinx-Dokumentation in den ersten Schritten liegen. Und das ist doch auch irgendwie offensichtlich. Es gibt ziemlich viele Python-Projekte die Sphinx verwenden und deren Quelltexte im Netz zu finden sind. Also Unmengen an Beispielen.

[Mungo1981]

Das Problem ist folgendes:
https://www.sphinx-doc.org/en/master/us ... start.html

Ist die Anleitung für den Einstieg.
Ich hab auch sauber ein:
$ sphinx-quickstart

durchgeführt und hab nun zwei Ordner:
1. Source
2. Build

Ich hab auch eine Datei:
master1.py

mit meinem Quellcode in Phython.

Die Funktionen in dieser Datei haben alle einen Doc-String
nur wenn ich dann sage make html

Ensteht eine html Datei(en) mit nicht viel Inhalt.
Somit denke ich in
Index,rst im Ordner Source.
Muss noch angegeben werden dass die Datei:
master1.py
gelessen werden soll.

Entweder das oder ich bin Blöder als Sphinx erlaubt.

[__blackjack__]

@Mungo1981: Das ist ziemlich am Ende des Einstiegsdokuments wo die Autodoc-Erweiterung erwähnt wird, die man dafür aktivieren muss.