cookiecutter-django/docs/index.rst

.. cookiecutter-django documentation master file.

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

A Cookiecutter_ template for Django.

.. _cookiecutter: https://github.com/audreyr/cookiecutter

.. note:: This is an in-progress documentation reorganization. Locations of files may change dramatically over the course of the next few days. See https://github.com/pydanny/cookiecutter-django/issues/335

Contents:

.. toctree::
   :maxdepth: 2


   project-generation-options
   developing-locally
   developing-locally-docker
   settings
   linters
   live-reloading-and-sass-compilation
   deployment-on-pythonanywhere
   deployment-on-heroku
   deployment-with-docker
   faq
   troubleshooting

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!`
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			`====================================================================`

			`A Cookiecutter_ template for Django.`

			`.. _cookiecutter: https://github.com/audreyr/cookiecutter`

Add documentation refactor note #335 2015-09-19 00:35:10 +03:00			`.. note:: This is an in-progress documentation reorganization. Locations of files may change dramatically over the course of the next few days. See https://github.com/pydanny/cookiecutter-django/issues/335`

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			`Contents:`

			`.. 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`
			`live-reloading-and-sass-compilation`
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`
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`
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`
			`==================`

			* :ref:`genindex`
			* :ref:`search`
Refactored the Docker docs and added indexes. 2015-09-19 00:26:29 +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.