diff options
| author | Chris McDonough <chrism@plope.com> | 2012-07-29 10:01:40 -0400 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2012-07-29 10:01:40 -0400 |
| commit | d204b348535e4f28df4d59d25aa9b493306d41e5 (patch) | |
| tree | 8027ef04a07bd0c01f60d347d8fca2ec4d8acc7c /HACKING.txt | |
| parent | c7fcdf1665cfdc1173559baa0a56d9a06fcba448 (diff) | |
| parent | 14f9fe44ec75c055d89374a7852e1ca2af0ff31c (diff) | |
| download | pyramid-d204b348535e4f28df4d59d25aa9b493306d41e5.tar.gz pyramid-d204b348535e4f28df4d59d25aa9b493306d41e5.tar.bz2 pyramid-d204b348535e4f28df4d59d25aa9b493306d41e5.zip | |
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'HACKING.txt')
| -rw-r--r-- | HACKING.txt | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/HACKING.txt b/HACKING.txt index dd735bf22..38c263ed7 100644 --- a/HACKING.txt +++ b/HACKING.txt @@ -127,13 +127,19 @@ using to develop Pyramid): 1. Run ``$yourvenv/bin/python setup.py dev docs``. This will cause Sphinx and all development requirements to be installed in your virtualenv. -2. cd to the ``docs`` directory within your Pyramid checkout and execute +2. Update all git submodules from the top-level of your Pyramid checkout, like + so: + git submodule update --init --recursive + This will checkout theme subrepositories and prevent error conditions when + HTML docs are generated. + +3. cd to the ``docs`` directory within your 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. -3. Open the ``docs/_build/html/index.html`` file to see the resulting HTML +4. Open the ``docs/_build/html/index.html`` file to see the resulting HTML rendering. Change Log |