|
| 1 | +#################### |
| 2 | +Para desarrolladores |
| 3 | +#################### |
| 4 | + |
| 5 | +Si quieres contribuir con virtualenvwrapper directamente, estas instrucciones |
| 6 | +deberían ayudarte a empezar. Parches, reporte de bugs, y propuestas de |
| 7 | +características son todas bienvenidas a través del `sitio de BitBucket |
| 8 | +<http://bitbucket.org/dhellmann/virtualenvwrapper/>`_. Contribuciones en la |
| 9 | +forma de parches o solicitud de pull son fáciles de integrar y recibirán |
| 10 | +prioridad en la atención. |
| 11 | + |
| 12 | +.. note:: |
| 13 | + |
| 14 | + Antes de contribuir con nuevas características al *core* de virtualenvwrapper, |
| 15 | + por favor considera, en vez, si no debe ser implementada como una extensión. |
| 16 | + |
| 17 | +Construir la documentación |
| 18 | +========================== |
| 19 | + |
| 20 | +La documentación para virtualenvwrapper está escrita en reStructuredText y |
| 21 | +convertida a HTML usando Sphinx. La propia construcción es impulsada por make. |
| 22 | +Necesitas los siguientes paquetes para construir la documentación: |
| 23 | + |
| 24 | +- Sphinx |
| 25 | +- docutils |
| 26 | + |
| 27 | +Una vez que todas las herramientas están instaladas dentro de un virtualen |
| 28 | +usando pip, ejecuta ``make html`` para generar la versión de HTML de la |
| 29 | +documentación:: |
| 30 | + |
| 31 | + $ make html |
| 32 | + rm -rf virtualenvwrapper/docs |
| 33 | + (cd docs && make html SPHINXOPTS="-c sphinx/pkg") |
| 34 | + sphinx-build -b html -d build/doctrees -c sphinx/pkg source build/html |
| 35 | + Running Sphinx v0.6.4 |
| 36 | + loading pickled environment... done |
| 37 | + building [html]: targets for 2 source files that are out of date |
| 38 | + updating environment: 0 added, 2 changed, 0 removed |
| 39 | + reading sources... [ 50%] command_ref |
| 40 | + reading sources... [100%] developers |
| 41 | + |
| 42 | + looking for now-outdated files... none found |
| 43 | + pickling environment... done |
| 44 | + checking consistency... done |
| 45 | + preparing documents... done |
| 46 | + writing output... [ 33%] command_ref |
| 47 | + writing output... [ 66%] developers |
| 48 | + writing output... [100%] index |
| 49 | + |
| 50 | + writing additional files... search |
| 51 | + copying static files... WARNING: static directory '/Users/dhellmann/Devel/virtualenvwrapper/plugins/docs/sphinx/pkg/static' does not exist |
| 52 | + done |
| 53 | + dumping search index... done |
| 54 | + dumping object inventory... done |
| 55 | + build succeeded, 1 warning. |
| 56 | + |
| 57 | + Build finished. The HTML pages are in build/html. |
| 58 | + cp -r docs/build/html virtualenvwrapper/docs |
| 59 | + |
| 60 | +La versión de publicación de la documentación termina dentro de |
| 61 | +``./virtualenvwrapper/docs`` |
| 62 | + |
| 63 | +Ejecutar tests |
| 64 | +============== |
| 65 | + |
| 66 | +La suite de test para virtualenvwrapper usa `shunit2 |
| 67 | +<http://shunit2.googlecode.com/>`_. Para ejecutar los tests en bash, sh, y zsh, |
| 68 | +usa ``make test``. |
| 69 | + |
0 commit comments