cookiecutter-django/docs/index.rst

.. cookiecutter-django documentation master file.

Welcome to Cookiecutter Django's documentation!
===============================================

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

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   1-getting-started/project-generation-options
   1-getting-started/settings

.. toctree::
   :maxdepth: 2
   :caption: Local Development

   2-local-development/developing-locally
   2-local-development/developing-locally-docker

.. toctree::
   :maxdepth: 2
   :caption: Deployment

   3-deployment/deployment-on-pythonanywhere
   3-deployment/deployment-on-heroku
   3-deployment/deployment-with-docker

.. toctree::
   :maxdepth: 2
   :caption: Guides

   4-guides/docker-postgres-backups
   4-guides/linters
   4-guides/testing
   4-guides/document
   4-guides/websocket

.. toctree::
   :maxdepth: 2
   :caption: Help

   5-help/faq
   5-help/troubleshooting

.. toctree::
   :maxdepth: 2
   :caption: About

   6-about/contributing
   6-about/maintainer-guide

Indices and tables
------------------

* :ref:`genindex`
* :ref:`search`

.. At some point it would be good to have a module index of the high level things we are doing. Then we can * :ref:`modindex` back in.