Steve Piercy
2016-12-27 6261ae4fbf73cb9e72aea2b8f67c6b04e5c474a6
narr/cookiecutters - add
narr/scaffolding - update
index - add link to narr/cookiecutters
1 files added
2 files modified
25 ■■■■■ changed files
docs/index.rst 1 ●●●● patch | view | raw | blame | history
docs/narr/cookiecutters.rst 20 ●●●●● patch | view | raw | blame | history
docs/narr/scaffolding.rst 4 ●●●● patch | view | raw | blame | history
docs/index.rst
@@ -145,6 +145,7 @@
   narr/extending
   narr/advconfig
   narr/extconfig
   narr/cookiecutters
   narr/scaffolding
   narr/upgrading
   narr/threadlocals
docs/narr/cookiecutters.rst
New file
@@ -0,0 +1,20 @@
.. _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>`_
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 `Cookiecutter Features <https://cookiecutter.readthedocs.io/en/latest/readme.html#features>`_.
.. seealso:: See also :term:`scaffold`.
docs/narr/scaffolding.rst
@@ -3,6 +3,10 @@
Creating Pyramid Scaffolds
==========================
.. deprecated:: 1.8
    Scaffolds and the ``pcreate`` script used to generate :app:`Pyramid` projects from scaffolds have been deprecated. Use :ref:`cookiecutters` instead.
You can extend Pyramid by creating a :term:`scaffold` template.  A scaffold
template is useful if you'd like to distribute a customizable configuration of
Pyramid to other users.  Once you've created a scaffold, and someone has