From 4214b1b8efcb86b264d64d3bf8592c382a70acd6 Mon Sep 17 00:00:00 2001 From: Andrew Chen Wang <60190294+Andrew-Chen-Wang@users.noreply.github.com> Date: Sun, 20 Jun 2021 12:47:07 -0400 Subject: [PATCH] Update docs/howto.rst --- {{cookiecutter.project_slug}}/docs/howto.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/{{cookiecutter.project_slug}}/docs/howto.rst b/{{cookiecutter.project_slug}}/docs/howto.rst index 25f442c3..0ef90d02 100644 --- a/{{cookiecutter.project_slug}}/docs/howto.rst +++ b/{{cookiecutter.project_slug}}/docs/howto.rst @@ -4,20 +4,19 @@ How To - Project Documentation 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' %} -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. {% 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 %} Changes to files in `docs/_source` will be picked up and reloaded automatically.