Reword introduction in documentation (#3452)

This commit is contained in:
Bruno Alla 2021-12-08 18:05:19 +00:00 committed by GitHub
parent 2c82876599
commit 5fd9b9ab8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 4 deletions

View File

@ -1,13 +1,14 @@
.. cookiecutter-django documentation master file.
Welcome to Cookiecutter Django's documentation!
====================================================================
===============================================
A Cookiecutter_ template for Django.
Powered by Cookiecutter_, Cookiecutter Django is a project template for jumpstarting production-ready Django projects. The template offers a number of generation options, we invite you to check the :ref:`dedicated page <template-options>` to learn more about each of them.
.. _cookiecutter: https://github.com/cookiecutter/cookiecutter
Contents:
Contents
--------
.. toctree::
:maxdepth: 2
@ -28,7 +29,7 @@ Contents:
troubleshooting
Indices and tables
==================
------------------
* :ref:`genindex`
* :ref:`search`

View File

@ -1,6 +1,12 @@
.. _template-options:
Project Generation Options
==========================
This page describes all the template options that will be prompted by the `cookiecutter CLI`_ prior to generating your project.
.. _cookiecutter CLI: https://github.com/cookiecutter/cookiecutter
project_name:
Your project's human-readable name, capitals and spaces allowed.