cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2025-03-03 19:08:15 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs/howto.rst

Browse Source
This commit is contained in:
Andrew Chen Wang 2021-06-20 12:47:07 -04:00 committed by GitHub
parent efcab1b4d6
commit 4214b1b8ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
{{cookiecutter.project_slug}}/docs/howto.rst
View File

@ -4,20 +4,19 @@ How To - Project Documentation
Get Started Get Started
---------------------------------------------------------------------- ----------------------------------------------------------------------
Documentation can be written as rst files in the `{{cookiecutter.project_slug}}/docs/_source`. Documentation can be written as rst files in `{{cookiecutter.project_slug}}/docs`.
{% if cookiecutter.use_docker == 'n' %} {% if cookiecutter.use_docker == 'n' %}
To build and serve docs, use the command: To build and serve docs, use the command::
::
make livehtml make livehtml
from inside the `{{cookiecutter.project_slug}}/docs` directory. from inside the `{{cookiecutter.project_slug}}/docs` directory.
{% else %} {% else %}
To build and serve docs, use the commands: To build and serve docs, use the commands::
::
docker-compose -f local.yml up docs
docker-compose -f local.yml up docs
{% endif %} {% endif %}
Changes to files in `docs/_source` will be picked up and reloaded automatically. Changes to files in `docs/_source` will be picked up and reloaded automatically.