Skip to content

Use RTD for preview #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Use RTD for preview
Move the local build to a FAQ, so we don't confuse people from the start.
  • Loading branch information
humitos committed May 25, 2020
commit dbed9af876c7d04584ada3dca6d23813d152e601
33 changes: 7 additions & 26 deletions .overrides/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 19 additions & 0 deletions .overrides/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Binary file added .overrides/readthedocs-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.