diff options
| author | Blaise Laflamme <blaise@laflamme.org> | 2011-11-26 18:31:22 -0500 |
|---|---|---|
| committer | Blaise Laflamme <blaise@laflamme.org> | 2011-11-26 18:31:22 -0500 |
| commit | 7613a6441f273ccc5642e20b2ce5788d01291466 (patch) | |
| tree | 8de6ce23bf54325b8524c50336020cb509ce1b16 /HACKING.txt | |
| parent | 11129ca073b4926037368d9a0bf079dc422e28f7 (diff) | |
| parent | 50e89abccc9c23949fb7cdd928a865712c34aa75 (diff) | |
| download | pyramid-7613a6441f273ccc5642e20b2ce5788d01291466.tar.gz pyramid-7613a6441f273ccc5642e20b2ce5788d01291466.tar.bz2 pyramid-7613a6441f273ccc5642e20b2ce5788d01291466.zip | |
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'HACKING.txt')
| -rw-r--r-- | HACKING.txt | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/HACKING.txt b/HACKING.txt index d122a7a25..593e89ac1 100644 --- a/HACKING.txt +++ b/HACKING.txt @@ -61,10 +61,10 @@ In order to add a feature to Pyramid: - The feature must work on the latest version of PyPy. -- The feature must not cause installation or runtime failure on Jython - or App Engine. If it doesn't cause installation or runtime failure, - but doesn't actually *work* on these platforms, that caveat should be - spelled out in the documentation. +- The feature must not cause installation or runtime failure on App Engine. + If it doesn't cause installation or runtime failure, but doesn't actually + *work* on these platforms, that caveat should be spelled out in the + documentation. - The feature must not depend on any particular persistence layer (filesystem, SQL, etc). @@ -73,10 +73,10 @@ In order to add a feature to Pyramid: "unnecessary" is of course subjective, but new dependencies should be discussed). -The above requirements are relaxed for paster template dependencies. -If a paster template has an install-time dependency on something that -doesn't work on a particular platform, that caveat should be spelled -out clearly in *its* documentation (within its ``docs/`` directory). +The above requirements are relaxed for scaffolding dependencies. If a +scaffold has an install-time dependency on something that doesn't work on a +particular platform, that caveat should be spelled out clearly in *its* +documentation (within its ``docs/`` directory). Coding Style ------------ @@ -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 ---------- |