Configurar Doxygen + Breathe + Sphynx + Readthedocs en el repo principal usando los ejemplos de código existentes

[Karosuo]

Objetivo
Configurar y documentar la forma en que se van a conectar dichas herramientas para que se pueda generar la documentación directamente del código en las API

Preferente pero no obligatorio
Adjuntar un github hook o una github task para que se compile la documentación con doxygen y se haga el pipeline automaticamente, de ser el caso, este agregado DEBE estar documentado en el framework, en caso de quererse duplicar en otra cuenta de github

Parece ser que el soporte principal es para sphynx

Si se quisiera usar con Doxygen, es posible, pero probablemente tenga que usarse un intermediario

• Ejemplos de uso de Doxygen + Breathe + Sphynx + Readthedocs
• Articulo Integrate Doxygen into Sphynx using Doxygen and Breath

Nota: Aún no queda claro si Sphynx soporta directamente C, para poder reemplazar a Doxygen, pero por lo pronto se hará la secuencia de Doxygen a Sphynx y readthedocs

---

Para usar read the docs, tenemos:

• Usando sphynx + readthedocs para documentar

• El tutorial principal de readthedocs.org

• La herramienta para importar un repo a read the docs

• El proyecto template en github o crear el propio desde cero

---

Conclusión:
No soporta Doxygen, solo Sphynx.
Se puede utilizar usando Breath.

[Karosuo]

Descripción de lo que son los Domains en Sphinx, con esto queda claro que no soporta la generación de documentación desde comentarios en C.
Sin embargo, soporta C como lenguaje dentro de la documentación ya generada de Sphinx, que es probable que Breathe lo maneje.