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

Merge branch 'master' into master

Browse Source
This commit is contained in:
Bruno Alla 2023-07-24 10:43:25 +01:00 committed by GitHub
commit cf31ddbfbf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,13 +8,13 @@ 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 %}
@ -34,12 +34,12 @@ For an in-use example, see the `page source <_sources/users.rst.txt>`_ for :ref:
To compile all docstrings automatically into documentation source files, use the command: To compile all docstrings automatically into documentation source files, use the command:
:: ::
make apidocs make apidocs
{% if cookiecutter.use_docker == 'y' %} {% if cookiecutter.use_docker == 'y' %}
This can be done in the docker container: This can be done in the docker container:
:: ::
docker run --rm docs make apidocs docker run --rm docs make apidocs
{% endif -%} {% endif -%}