Ich werde API Python Sphinx schreiben, mkdocs Dokumentation

Gute Dokumentation bedeutet, dass deine Nutzer deine Software oder dein Tutorial effizient und in kurzer Zeit nutzen können. Es gibt viele verfügbare Tools, aber Sphinx ist der De-facto-Standard für Python. Du kannst Sphinx auch für alle Arten von Tutorials verwenden.

Sphinx kann auch Notizen im Code lesen und schöne Dokumentationen ausgeben.

Ich kann dir helfen:

• deine API zu dokumentieren (Django, FastAPI) und/oder dein Tutorial von Grund auf zu erstellen
• Notizen in deinem Code zu schreiben, damit sie von Sphinx gelesen werden können (Docstrings)
• Sphinx zu initialisieren, damit es Funktions- oder Klassen-Docstrings lesen kann
• deine bestehende Dokumentation zu verbessern, auch durch Hinzufügen von Referenzen
• dir Vorschläge zu machen, wie du deine Dokumentation verbessern kannst
• dir bei Problemen mit dem Aufbau der Sphinx-Dokumentation zu helfen (zusätzlich)
• Python-Type-Annotations in deinem API-Code hinzuzufügen: verbessert Code- und Dokumentationsqualität (zusätzlich)
• Quarto, Mkdocs und können deine FastAPI-Endpunktbeschreibungen verbessern

Sphinx kann Ausgaben in verschiedenen Formaten erzeugen. Das gängigste ist normalerweise HTML.

Ich kann deine Dokumentation auf Englisch, Italienisch oder Französisch schreiben.

Meine Python-Projekte und Tutorials verwenden Sphinx. Ich nutze:

• GNU/Linux
• GIT-Repositories
• RST-, Markdown-Dateien
• venv
• Makefiles
• Docker (docker-compose)