Ik zal API python sphinx, mkdocs documentatie schrijven

Een goede documentatie betekent dat je gebruikers je software of tutorial efficiënt kunnen gebruiken en in korte tijd. Er zijn veel beschikbare tools, maar Sphinx is de de-facto standaard voor Python. Je kunt Sphinx ook gebruiken voor allerlei soorten tutorials.

Met Sphinx kun je ook notities in de code lezen en mooie documentatie genereren.

Ik kan je helpen:

• je API (Django, FastAPI) documenteren en/of je tutorial vanaf nul opzetten
• notities in je code schrijven zodat ze door Sphinx gelezen kunnen worden (docstrings)
• Sphinx initialiseren zodat het function- of class-docstrings kan lezen
• je bestaande documentatie verbeteren, ook door referenties toe te voegen
• je suggesties geven om je documentatie te verbeteren
• je helpen problemen op te lossen bij het bouwen van de Sphinx-documentatie (extra)
• Python type annotation toevoegen aan je API-code: verbetert code- en documentatiekwaliteit (extra)
• Quarto, Mkdocs, en kan je FastAPI endpoint beschrijvingen verbeteren

Sphinx kan output genereren in verschillende formaten. Meestal is HTML het meest gebruikelijk.

Ik kan je documentatie schrijven in het Engels, Italiaans of Frans.

Mijn Python-projecten en tutorials gebruiken Sphinx. Ik gebruik:

• GNU/Linux
• GIT-repositories
• RST-, markdown-bestanden
• venv
• Makefiles
• Docker (docker-compose)