Escribiré la documentación de API python sphinx, mkdocs

Contar con una buena documentación significa que tus usuarios pueden disfrutar de tu software o tutorial de manera eficiente y en poco tiempo. Hay muchas herramientas disponibles, pero Sphinx es el estándar de facto para Python. También puedes usar Sphinx para cualquier tipo de tutoriales.

Además, Sphinx puede leer notas en el código y generar una documentación hermosa.

Puedo ayudarte a:

• documentar tu API (Django, FastAPI) y/o crear tu tutorial desde cero
• escribir notas en tu código para que puedan ser leídas por Sphinx (docstrings)
• inicializar Sphinx para que pueda leer los docstrings de funciones o clases
• mejorar tu documentación existente, también agregando referencias
• darte sugerencias para mejorar tu documentación
• ayudarte a solucionar problemas para construir la documentación con Sphinx (extra)
• agregar anotaciones de tipo en tu código API: mejora la calidad del código y la documentación (extra)
• Quarto, Mkdocs, y pueden mejorar las descripciones de tus endpoints en FastAPI

Sphinx puede generar salidas en varios formatos. Por lo general, el más común es HTML.

Puedo escribir tu documentación en inglés, italiano o francés.

Mis proyectos en Python y mis tutoriales usan Sphinx. Utilizo:

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