Skip to content

Update makefile #26

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.

Sign up for GitHub

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 6 commits into from
May 2, 2020
Merged

Update makefile #26

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9a68f23
update gitignore
gilgamezh May 1, 2020
1d7fa53
updated makefile
gilgamezh May 1, 2020
079e95a
contributing draft
gilgamezh May 1, 2020
444cc91
update travis command
gilgamezh May 1, 2020
2a74cca
Merge branch '3.7' into update_makefile
gilgamezh May 2, 2020
9ed64a6
update to use cpython as a git module
gilgamezh May 2, 2020
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
Prev Previous commit
Next Next commit
contributing draft
  • Loading branch information
@gilgamezh
gilgamezh committed May 1, 2020
commit 079e95aafe98c8e3cbad44af5b5dfcc3ba8fb456
38 changes: 38 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Guía para contribuir en la documentación utilizando Github
===========================================================

Crea un fork y clona el repositorio
-----------------------------------

https://help.github.com/en/github/getting-started-with-github/fork-a-repo

Luego de tener un fork clonalo en tu maquina

.. code-block:: bash

# Git clone your github fork using ssh (replace raulcd):
# Clona el repositorio en tu maquina ejecutando
git@github.com:<TU_USUARIO>/python-docs-es.git

# Ingresá al nuevo directorio con el repo
cd python-docs-es/

# Agregá el repositorio original como upstream.
git remote add upstream https://github.com/raulcd/python-docs-es.git


Crear un build local
--------------------

Hay un script para automatizar estos pasos el mismo va a:

- Crear un virtualenv dentro del directorio del repositorio e instalar en el mismo las librearias necesarias
- Clonar el repositorio oficial de cpython para construir ("biuldear") la documentación.

.. code-block:: bash

make build

# luego para poder ver la documentación ejecuta el siguiente comando y podes luego ir a http://localhost:8000 para ver la documentación
# recién construida.
make serve