Crear el proyecto ejemplo de Sphynx, incluirlo en CoDe Pretzel Docs repo y subirlo a read the docs

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

Crear el proyecto ejemplo de Sphynx, incluirlo en CoDe Pretzel Docs repo y subirlo a read the docs #12

Closed Karosuo closed 2 years ago

Karosuo commented 2 years ago

Para tener una idea de cómo se ve y qué es necesario mínimamente para tener la documentación.

Esto implica que se usaría el template de read the docs, que está basado en python y puede tener un par de diferencias importantes con la documentación de C, principalmente la habilidad de generar la documentación "automáticamente", según Sphynx, aunque no está claro aún qué significa.

Karosuo commented 2 years ago

Actualmente se puede acceder desde https://code-pretzel-framework.readthedocs.io/es/latest/

Usar un subdominio parecer estart teniendo problemas en el lado de hostgator, se incluyó una tarea en trello para resolverlo

Karosuo commented 2 years ago

Este issue se unión con el #11 debido a que no se podría lograr un pull request para un repositorio externo como lo es CoDePretzel_Framework_Docs. Además, el objetivo a largo plazo es integrarlo en el mismo repositorio