diff options
| author | Chris McDonough <chrism@plope.com> | 2011-11-18 07:51:48 -0500 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2011-11-18 07:51:48 -0500 |
| commit | 319806b49a8d2e8c8bbf61a1886eb206790d18e4 (patch) | |
| tree | d8dc7ad2b300332816331d20c1c55aacefbe11d8 /HACKING.txt | |
| parent | 9ffa36dde53afda0a5a15b096e2fcd9c54a88ea2 (diff) | |
| download | pyramid-319806b49a8d2e8c8bbf61a1886eb206790d18e4.tar.gz pyramid-319806b49a8d2e8c8bbf61a1886eb206790d18e4.tar.bz2 pyramid-319806b49a8d2e8c8bbf61a1886eb206790d18e4.zip | |
add instructions about how to build docs (closes #348)
Diffstat (limited to 'HACKING.txt')
| -rw-r--r-- | HACKING.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/HACKING.txt b/HACKING.txt index d122a7a25..daa4f614b 100644 --- a/HACKING.txt +++ b/HACKING.txt @@ -121,6 +121,16 @@ Documentation Coverage that API or behavior must change to reflect the bug fix, ideally in the same commit that fixes the bug or adds the feature. +- To build and review docs: + + 1. Install ``tests_require`` dependencies from Pyramid's setup.py into your + virtualenv. + + 2. From the ``docs`` directory of the Pyramid checkout run ``make html + SPHINXBUILD=/path/to/your/virtualenv/bin/sphinx-build``. + + 3. Open the _build/html/index.html file to see the resulting rendering. + Change Log ---------- |