Scriverò la documentazione API python sphinx, mkdocs

Avere una buona documentazione significa che i tuoi utenti possono utilizzare il tuo software o tutorial in modo efficiente e in breve tempo. Ci sono molti strumenti disponibili, ma Sphinx è lo standard de-facto per Python. Puoi usare Sphinx anche per qualsiasi tipo di tutorial.

Sphinx può anche leggere note nel codice e generare una documentazione bella e ben strutturata.

Posso aiutarti a:

• documentare la tua API (Django, FastAPI) e/o creare il tuo tutorial da zero
• scrivere note nel tuo codice in modo che possano essere lette da Sphinx (docstring)
• inizializzare Sphinx in modo che possa leggere le docstring di funzioni o classi
• migliorare la tua documentazione esistente, anche aggiungendo riferimenti
• darti suggerimenti per migliorare la tua documentazione
• aiutarti a risolvere problemi nella creazione della documentazione con Sphinx (extra)
• aggiungere annotazioni di tipo Python nel tuo codice API: migliora qualità del codice e della documentazione (extra)
• Quarto, Mkdocs, e può migliorare le descrizioni dei tuoi endpoint FastAPI

Sphinx può generare output in vari formati. Di solito il più comune è HTML.

Posso scrivere la tua documentazione in inglese, italiano o francese.

I miei progetti Python e i miei tutorial usano Sphinx. Uso:

• GNU/Linux
• repository GIT
• file RST, markdown
• venv
• Makefile
• Docker (docker-compose)