diff options
| author | Blaise Laflamme <blaise@laflamme.org> | 2012-08-02 23:20:20 -0400 |
|---|---|---|
| committer | Blaise Laflamme <blaise@laflamme.org> | 2012-08-02 23:20:20 -0400 |
| commit | 059017df8ca73660734072de1b781940b9079dd4 (patch) | |
| tree | 12141bd7011001ec860911bb4d5d00f55a668ca5 /HACKING.txt | |
| parent | d4147eb8dc4962fa86863c77fc190717113994a7 (diff) | |
| parent | 1bbe668972a6ac3b116f44e50825c66ae5813326 (diff) | |
| download | pyramid-059017df8ca73660734072de1b781940b9079dd4.tar.gz pyramid-059017df8ca73660734072de1b781940b9079dd4.tar.bz2 pyramid-059017df8ca73660734072de1b781940b9079dd4.zip | |
Merge branch 'refs/heads/master' into fix.mako-606
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 |