From 319806b49a8d2e8c8bbf61a1886eb206790d18e4 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 18 Nov 2011 07:51:48 -0500 Subject: add instructions about how to build docs (closes #348) --- HACKING.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'HACKING.txt') 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 ---------- -- cgit v1.2.3 From 17863d878b4cc47342eb1e7606df99178700beb3 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 18 Nov 2011 09:47:06 -0500 Subject: paster template -> scaffold --- HACKING.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'HACKING.txt') diff --git a/HACKING.txt b/HACKING.txt index daa4f614b..24d1b48a1 100644 --- a/HACKING.txt +++ b/HACKING.txt @@ -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 ------------ -- cgit v1.2.3 From 40b3a8a15e972a7d1dc0b0c7909d3e2a24f91afe Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 18 Nov 2011 09:47:40 -0500 Subject: remove jython --- HACKING.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'HACKING.txt') diff --git a/HACKING.txt b/HACKING.txt index 24d1b48a1..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). -- cgit v1.2.3