summaryrefslogtreecommitdiff
path: root/docs/narr/cookiecutters.rst
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2017-01-02 19:22:28 -0600
committerGitHub <noreply@github.com>2017-01-02 19:22:28 -0600
commitf01e74d21e7cadd052c1853d7fe482bd7b9970fa (patch)
treeabcec287bda4b706bfa3e6bc40601d0883206122 /docs/narr/cookiecutters.rst
parentfc163d411bd57b232f68ed6554aff3a3ef8f2339 (diff)
parenta36d33bf7872575fb79cdc0e5959a62b30df5742 (diff)
downloadpyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.tar.gz
pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.tar.bz2
pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.zip
Merge pull request #2889 from stevepiercy/docs-cookiecutter-changes-only
Docs cookiecutter changes only - Quick Tutorial and all other files
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`.