cookiecutter-django/{{cookiecutter.project_slug}}/docs/_source/index.rst
Hannah Lazarus 3152bdaeb3 Add sphinx defaults for cookiecutter'd project
-serve, watch + live reload for docs + code file changes
-update project makefile + make.bat
-separate _source and _build
-add packages and paths to use autodoc
-edit/add documentation with examples (both at django-cookiecutter and inside generated project)
-add formatted comments in User model for pickup by Sphinx apidoc
-serve docs from a separate docs container for docker build
2020-04-30 13:23:24 -04:00

25 lines
536 B
ReStructuredText

.. {{ cookiecutter.project_name }} documentation master file, created by
sphinx-quickstart.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to {{ cookiecutter.project_name }}'s documentation!
======================================================================
.. toctree::
:maxdepth: 2
:caption: Contents:
howto
pycharm/configuration
users
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`