README.markdown 1.0 KB

¿Qué es este repositorio?

Se trata de un proyecto realizado para enseñar a utilizar HTML, concretamente la versión 5.1 (la última a día de hoy).

¿Cómo funciona?

Para generar los manuales utilizamos Sphinx, lo que nos permite generar documentación para distintos formatos.

Para generar la documentación en formato HTML debes seguir los siguientes pasos:

  1. Descarga o clona el repositorio con Git.
  2. Instala Python y Sphinx (pip install Sphinx).
  3. Ejecuta make html en la carpeta raíz del repositorio. Si usas Windows y no tienes el programa make, puedes ejecutar sphinx-build -b html . _build/html/.
  4. La documentación estará disponible en el directorio _build/html/. Puedes abrir el archivo index.html que encontrarás en ese directorio con tu navegador favorito.

No obstante, puedes generar la documentación en cualquier otro formato ofrecido por Sphinx. Lee la documentación de Sphinx para descubrir cómo trabajar con otros formatos.