diff --git a/.overrides/CONTRIBUTING.rst b/.overrides/CONTRIBUTING.rst index fec2f181f9..2fdcf0d2c6 100644 --- a/.overrides/CONTRIBUTING.rst +++ b/.overrides/CONTRIBUTING.rst @@ -151,34 +151,15 @@ A tener en cuenta Previsualizar los cambios ------------------------- -Hay dos formas de visualizar, junto con el resultado final de la documentación, -los cambios que has hecho. +Una vez que hayas hecho un *Pull Request* en GitHub, este mostrará al final de página una sección de "check". +Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es`` y al lado un link de "Details". -Read the Docs -````````````` +.. figure:: readthedocs-preview.png + :width: 85% + :align: center -Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de -página una sección de "check". Allí debería haber uno que diga -``docs/readthedocs.org:python-docs-es`` y al lado un link de "Details". - -Haciendo click en ese link verás una versión de la documentación con tus -cambios. - -Construcción local -`````````````````` - -Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git -clone`` puedes ejecutar:: - - make build - -Este comando demorará unos minutos y generará toda la documentación en formato -HTML en tu computadora. Puedes ver el resultado con tu navegador de internet -(Firefox, Chrome, etc) ejecutando:: - - make serve - -Y luego accediendo a http://localhost:8000/ +Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios. +Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build. .. _repositorio: https://github.com/python/python-docs-es diff --git a/.overrides/faq.rst b/.overrides/faq.rst index 82896a693a..5ad3faa2f1 100644 --- a/.overrides/faq.rst +++ b/.overrides/faq.rst @@ -150,3 +150,22 @@ Luego, cada vez que realices un commit se ejecutará ``pre-commit`` y validará Si por cualquier motivo no está funcionando ``pre-commit`` y no te deja hacer *push* de tus cambios, lo puedes desinstalar simplemente mediante: ``pre-commit uninstall``. + + +¿Cómo puedo hacer un *build* local de la documentación? +------------------------------------------------------- + +.. note:: + + Necesitas un poco de conocimiento para instalar ``make`` en tu sistema operativo. + +Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git clone`` puedes ejecutar:: + + make build + +Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora. +Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando:: + + make serve + +Y luego accediendo a http://localhost:8000/ diff --git a/.overrides/readthedocs-preview.png b/.overrides/readthedocs-preview.png new file mode 100644 index 0000000000..67a14f4dcb Binary files /dev/null and b/.overrides/readthedocs-preview.png differ