CoDePretzel / CoDePretzel_Framework

Una infraestructura libre (O/S) de herramientas, técnicas y configuraciones que nos permita desarrollar software embebido de calidad, con facilidad de replicación, modularidad y con un proceso de desarrollo establecido.
Apache License 2.0
0 stars 0 forks source link

Integrar el uso de read the docs en el repo principal de CoDePretzel_Framework #11

Closed Karosuo closed 2 years ago

Karosuo commented 2 years ago

Es importante confirmar si la estructura que usa Sphynx (y por tanto read the docs) incluye el código fuente y otros elementos de documentación en el mismo repositorio. Nosotros tenemos 2 repositorios diferentes, uno para código y el otro para pura documentación.

Sin embargo, de ser necesario serán unidos en el repo principal y CoDePretzel_Framework_Docs se eliminaría.

Para asegurar que este paso se aclare, es necesario:

  1. Seguir el tutorial sphynx
  2. Revisar si la documentación y el código viven en el mismo repo
  3. Importar la documentación al repo principal CoDe Pretzel Framework
  4. Eliminar el proyecto anterior de read the docs
  5. Importar el repo principal a read the docs
  6. Re compilar la documentación
  7. Seguir el tutorial principal de read the docs
Karosuo commented 2 years ago

Aparentemente sphynx puede soportar C/C++ directamente.

Sin embargo no está claro hasta qué punto se puede hacer tan sencillo y/o automático como en Doxygen

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

Nota: Aún se está revisando si Sphynx soporta directamente C, para poder reemplazar a Doxygen