diff options
| author | Jeff Cook <jeff@deserettechnology.com> | 2012-07-04 18:52:54 -0600 |
|---|---|---|
| committer | Jeff Cook <jeff@deserettechnology.com> | 2012-07-04 18:52:54 -0600 |
| commit | 6ef753257617acf8aaf3daaca22de3783970cffe (patch) | |
| tree | 0cb4701170c2d68126ad98f7fa15e8c2be4b8742 /HACKING.txt | |
| parent | 71b473705f73b12a35422d3aa257906e4a99d853 (diff) | |
| download | pyramid-6ef753257617acf8aaf3daaca22de3783970cffe.tar.gz pyramid-6ef753257617acf8aaf3daaca22de3783970cffe.tar.bz2 pyramid-6ef753257617acf8aaf3daaca22de3783970cffe.zip | |
Include instructions for recursive submodule checkout of Sphinx themes.
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 |