summaryrefslogtreecommitdiff
path: root/docs/narr/cookiecutters.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2017-02-17 20:38:40 -0500
committerChris McDonough <chrism@plope.com>2017-02-17 20:38:40 -0500
commitb2e8884a94d9e869bf29ea55298ad308f16ed420 (patch)
treee46bf79d1a8811ad273a40ce194d05836fcc7409 /docs/narr/cookiecutters.rst
parent7bb06f28ee296ecf43ba63279fc4c2439b4571d3 (diff)
parent40d71e805bfcf8522c6af71995c05c496f1c4b4f (diff)
downloadpyramid-b2e8884a94d9e869bf29ea55298ad308f16ed420.tar.gz
pyramid-b2e8884a94d9e869bf29ea55298ad308f16ed420.tar.bz2
pyramid-b2e8884a94d9e869bf29ea55298ad308f16ed420.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs/narr/cookiecutters.rst')
-rw-r--r--docs/narr/cookiecutters.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/narr/cookiecutters.rst b/docs/narr/cookiecutters.rst
new file mode 100644
index 000000000..abedb25b9
--- /dev/null
+++ b/docs/narr/cookiecutters.rst
@@ -0,0 +1,22 @@
+.. _cookiecutters:
+
+Pyramid cookiecutters
+=====================
+
+.. versionadded:: 1.8
+
+A :term:`cookiecutter` is a command-line utility that creates projects from :ref:`cookiecutters <cookiecutter:readme>` (project templates), e.g., creating a Python package project from a Python package project template.
+
+Pyramid cookiecutters have replaced the now deprecated Pyramid scaffolds, and should be used going forward. Pyramid cookiecutters released under the Pylons Project include:
+
+* `pyramid-cookiecutter-alchemy <https://github.com/Pylons/pyramid-cookiecutter-alchemy>`_
+* `pyramid-cookiecutter-starter <https://github.com/Pylons/pyramid-cookiecutter-starter>`_
+* `pyramid-cookiecutter-zodb <https://github.com/Pylons/pyramid-cookiecutter-zodb>`_
+
+.. seealso::
+
+ See also `Cookiecutter Installation <https://cookiecutter.readthedocs.io/en/latest/installation.html>`_ and `Cookiecutter Features <https://cookiecutter.readthedocs.io/en/latest/readme.html#features>`_. Development of cookiecutters is documented under `Learn the Basics of Cookiecutter by Creating a Cookiecutter <https://cookiecutter.readthedocs.io/en/latest/first_steps.html>`_.
+
+.. seealso::
+
+ See also :term:`scaffold`.