¿Cómo escribir documentación API limpia y hermosa? ¿Hay marcos de trabajo de código abierto disponibles?
¡¡¡Necesitas Sphinx!!!
La documentación oficial de Python está escrita en él. Pero tenga en cuenta que Sphinx es una herramienta de redacción de documentación, no un conocido motor de búsqueda de texto completo.
Sphinx utiliza la sintaxis de marcado reStructuredText (entre otras sintaxis) para proporcionar control de documentos.
Más convenientemente, primero hay un editor en línea en http://rst.ninjs.org/, por lo que puede escribir documentación API como si usara el editor y luego copiarla a Just en su Sphinx. proyecto.
Por último, crea un documento html que genere una página estática. También puedes elegir o personalizar una plantilla.