J'écrirai l'API Python Sphinx, la documentation MKDocs

Avoir une bonne documentation signifie que vos utilisateurs peuvent profiter de votre logiciel ou tutoriel efficacement et en peu de temps. Il existe de nombreux outils disponibles, mais Sphinx est la référence pour Python. Vous pouvez également utiliser Sphinx pour tout type de tutoriels.

Sphinx peut aussi lire des notes dans le code et produire une documentation magnifique.

Je peux vous aider :

• à documenter votre API (Django, FastAPI) et/ou à créer votre tutoriel de zéro
• à écrire des notes dans votre code pour qu’elles soient lisibles par Sphinx (docstrings)
• à initialiser Sphinx pour qu’il puisse lire les docstrings des fonctions ou des classes
• à améliorer votre documentation existante, notamment en ajoutant des références
• à vous donner des suggestions pour améliorer votre documentation
• à vous aider à résoudre les problèmes pour construire la documentation Sphinx (supplément)
• à ajouter des annotations de type Python dans votre code API : améliore la qualité du code et de la documentation (supplément)
• Quarto, Mkdocs, et peuvent améliorer la description de vos endpoints FastAPI

Sphinx peut générer des sorties dans différents formats. Le plus courant est généralement HTML.

Je peux rédiger votre documentation en anglais, italien ou français.

Mes projets Python et mes tutoriels utilisent Sphinx. J’utilise :

• GNU/Linux
• les dépôts GIT
• les fichiers RST, markdown
• venv
• Makefiles
• Docker (docker-compose)