Files changed (3)
+If you would like to contribute, these instructions should help you get started. Patches, bug reports, and feature requests are all welcome through the `BitBucket site <http://bitbucket.org/dhellmann/virtualenvwrapper/>`_. Contributions in the form of patches or pull requests are easier to integrate and will receive priority attention.
+The documentation for virtualenvwrapper is written in reStructuredText and converted to HTML using Sphinx. The build itself is driven by Paver. You will need the following packages in order to build the docs:
+Once all of them are installed into a virtualenv using easy_install, run ``paver html`` to generate the HTML version of the documentation::
+ sphinx-build -b html -d ./docs/doctrees -c sphinx/pkg -Aproject=virtualenvwrapper ./docsource ./docs/html
+ /Users/dhellmann/Devel/virtualenvwrapper/src/docsource/developers.rst:19: (WARNING/2) Literal block expected; none found.
+ copying static files... WARNING: static directory '/Users/dhellmann/Devel/virtualenvwrapper/src/sphinx/pkg/static' does not exist
+The test suite for virtualenvwrapper uses `shunit2 <http://shunit2.googlecode.com/>`_. To run the tests under both bash and zsh, use ``paver test``. To add new tests, modify the ``tests/test.sh`` script with new test functions.