From 97c0363141fce27dc938e9b0a3e73c187bc511d4 Mon Sep 17 00:00:00 2001 From: Omer-5 Date: Tue, 13 Dec 2022 21:16:31 +0200 Subject: [PATCH] generate project refactor and fix --- docs/developing-locally-docker.rst | 6 +++--- docs/developing-locally.rst | 5 ++--- docs/generate-project-block.rst | 7 +++++++ 3 files changed, 12 insertions(+), 6 deletions(-) create mode 100644 docs/generate-project-block.rst diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 0b62d8fff..a7d77e108 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -3,9 +3,6 @@ Getting Up and Running Locally With Docker .. index:: Docker -The steps below will get you up and running with a local development environment. -All of these commands assume you are in the root of your generated project. - .. note:: If you're new to Docker, please be aware that some resources are cached system-wide @@ -26,6 +23,9 @@ Prerequisites .. _`pre-commit`: https://pre-commit.com/#install .. _`Cookiecutter`: https://github.com/cookiecutter/cookiecutter +Before Getting Started +---------------------- +.. include:: generate-project-block.rst Build the Stack --------------- diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 3581ef245..e1c946268 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -24,9 +24,8 @@ First things first. $ source /bin/activate -#. Install cookiecutter-django: :: - - $ cookiecutter gh:cookiecutter/cookiecutter-django +#. + .. include:: generate-project-block.rst #. Install development requirements: :: diff --git a/docs/generate-project-block.rst b/docs/generate-project-block.rst new file mode 100644 index 000000000..2842b551d --- /dev/null +++ b/docs/generate-project-block.rst @@ -0,0 +1,7 @@ +Generate a new cookiecutter-django project: :: + + $ cookiecutter gh:cookiecutter/cookiecutter-django + +For more information refer to +:ref:`Project Generation Options `. +