diff options
| author | Chris McDonough <chrism@plope.com> | 2012-06-11 11:03:56 -0400 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2012-06-11 11:03:56 -0400 |
| commit | 8c4210f94132e2ba844732bd1dada82696fc20db (patch) | |
| tree | 9748a89514d975834e0a000166f59d4a532c3194 /HACKING.txt | |
| parent | dcab614e3252054eba5f2333af8bc3c4120e9980 (diff) | |
| download | pyramid-8c4210f94132e2ba844732bd1dada82696fc20db.tar.gz pyramid-8c4210f94132e2ba844732bd1dada82696fc20db.tar.bz2 pyramid-8c4210f94132e2ba844732bd1dada82696fc20db.zip | |
how to build HTML docs
Diffstat (limited to 'HACKING.txt')
| -rw-r--r-- | HACKING.txt | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/HACKING.txt b/HACKING.txt index 593e89ac1..ec0bcb000 100644 --- a/HACKING.txt +++ b/HACKING.txt @@ -48,6 +48,23 @@ checkout. $ cd starter $ ../bin/python setup.py develop +Building the HTML Docs +----------------------- + +- Check out Pyramid from Github. + +- Create a virtualenv or reuse an existing one that you're using to develop + Pyramid. + +- Run ``$yourvenv/bin/python setup.py dev docs``. + +- cd to ``docs`` within the Pyramid checkout and execute ``make clean html + SPHINXBUILD=$yourvenv/bin/sphinx-build``. The ``SPHINXBUILD=...`` hair is + there in order to tell it to use the virtualenv Python, which will have + both Sphinx and Pyramid (for API documentation generation) installed. + +- The rendered HTML docs will end up in ``docs/_build/html``. + Adding Features --------------- |