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

Contents
--------

.. toctree::
   :maxdepth: 2

   project-generation-options
   developing-locally
   developing-locally-docker
   settings
   linters
   testing
   document
   deployment-on-pythonanywhere
   deployment-on-heroku
   deployment-with-docker
   docker-postgres-backups
   websocket
   faq
   troubleshooting
   contributing
   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.
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00			`.. cookiecutter-django documentation master file.`

Update name per #524 2016-05-09 07:31:12 +03:00			`Welcome to Cookiecutter Django's documentation!`
Reword introduction in documentation (#3452) 2021-12-08 21:05:19 +03:00			`===============================================`
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00
Reword introduction in documentation (#3452) 2021-12-08 21:05:19 +03:00			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.
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00
Migrate book domain to Feldroy and other small fixes 2020-03-25 17:57:33 +03:00			`.. _cookiecutter: https://github.com/cookiecutter/cookiecutter`
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00
Reword introduction in documentation (#3452) 2021-12-08 21:05:19 +03:00			`Contents`
			`--------`
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00
			`.. toctree::`
			`:maxdepth: 2`

Document the project generation options. 2015-10-14 22:59:14 +03:00			`project-generation-options`
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00			`developing-locally`
			`developing-locally-docker`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`settings`
			`linters`
EDITED the developing locally doc. 2018-11-20 00:06:54 +03:00			`testing`
Update docs files 2019-12-28 12:26:43 +03:00			`document`
Added PythonAnywhere to the docs index 2016-04-27 07:57:38 +03:00			`deployment-on-pythonanywhere`
Big reorganization of documentation 2015-09-18 20:20:48 +03:00			`deployment-on-heroku`
			`deployment-with-docker`
Breakup the backups section for docker into its own document 2016-06-15 00:32:14 +03:00			`docker-postgres-backups`
:pencil: added websockets doc page #2506 * Simple explanation. * Example of usage with JS. * Additional nGinx config example. 2020-05-26 01:25:38 +03:00			`websocket`
Add FAQ and early work on file copier #335 2015-09-18 20:55:06 +03:00			`faq`
Adding troubleshotting to index 2016-06-03 22:04:11 +03:00			`troubleshooting`
Include contributing page to the docs (#4144) * Add MyST parser * Include contributing page to the docs 2023-03-04 21:45:25 +03:00			`contributing`
Add a maintainer guide to the docs 2024-02-22 12:39:45 +03:00			`maintainer-guide`
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00
			`Indices and tables`
Reword introduction in documentation (#3452) 2021-12-08 21:05:19 +03:00			`------------------`
Beginning of reorganization of documentation per #335 * Created top-level docs Sphinx directory * Moved development instructions out of /README.rst and into /docs/ 2015-09-18 19:22:55 +03:00
			* :ref:`genindex`
			* :ref:`search`
Refactored the Docker docs and added indexes. 2015-09-19 00:26:29 +03:00
Fix index.rst sphinx warnings (#1166) 2017-06-20 23:29:31 +03:00			.. 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.