Group docs into sections (cookiecutter#5426)

foarsitter · Oct 5, 2024 · b0c4522 · b0c4522
1 parent 6c64a81
commit b0c4522
Show file tree

Hide file tree

Showing 20 changed files with 67 additions and 45 deletions.
diff --git a/docs/project-generation-options.rst → ...ng-started/project-generation-options.rst b/docs/project-generation-options.rst → ...ng-started/project-generation-options.rst
diff --git a/docs/settings.rst → docs/1-getting-started/settings.rst b/docs/settings.rst → docs/1-getting-started/settings.rst
diff --git a/docs/developing-locally-docker.rst → ...development/developing-locally-docker.rst b/docs/developing-locally-docker.rst → ...development/developing-locally-docker.rst
@@ -257,7 +257,7 @@ Here is a link to an article on `how to add HTTPS using Nginx`_ to your local do
 Webpack
 ~~~~~~~
 
-If you are using Webpack, first install ``mkcert``_. It is a simple by design tool that hides all the arcane knowledge required to generate valid TLS certificates. It works for any hostname or IP, including localhost. It supports macOS, Linux, and Windows, and Firefox, Chrome and Java. It even works on mobile devices with a couple manual steps. See https://blog.filippo.io/mkcert-valid-https-certificates-for-localhost/
+If you are using Webpack, first install `mkcert`_. It is a simple by design tool that hides all the arcane knowledge required to generate valid TLS certificates. It works for any hostname or IP, including localhost. It supports macOS, Linux, and Windows, and Firefox, Chrome and Java. It even works on mobile devices with a couple manual steps. See https://blog.filippo.io/mkcert-valid-https-certificates-for-localhost/
 
 .. _`mkcert`:  https://github.com/FiloSottile/mkcert/blob/master/README.md#supported-root-stores
 
@@ -267,36 +267,36 @@ Assuming that you registered your local hostname as ``my-dev-env.local``, the ce
 
 1. Add the ``nginx-proxy`` service to the ``docker-compose.local.yml``. ::
 
-  nginx-proxy:
-    image: jwilder/nginx-proxy:alpine
-    container_name: nginx-proxy
-    ports:
-      - "80:80"
-      - "443:443"
-    volumes:
-      - /var/run/docker.sock:/tmp/docker.sock:ro
-      - ./certs:/etc/nginx/certs
-    restart: always
-    depends_on:
-      - node
-    environment:
-      - VIRTUAL_HOST=my-dev-env.local
-      - VIRTUAL_PORT=3000
+    nginx-proxy:
+      image: jwilder/nginx-proxy:alpine
+      container_name: nginx-proxy
+      ports:
+        - "80:80"
+        - "443:443"
+      volumes:
+        - /var/run/docker.sock:/tmp/docker.sock:ro
+        - ./certs:/etc/nginx/certs
+      restart: always
+      depends_on:
+        - node
+      environment:
+        - VIRTUAL_HOST=my-dev-env.local
+        - VIRTUAL_PORT=3000
 
 2. Add the local secure domain to the ``config/settings/local.py``. You should allow the new hostname ::
 
-  ALLOWED_HOSTS = ["localhost", "0.0.0.0", "127.0.0.1", "my-dev-env.local"]
+    ALLOWED_HOSTS = ["localhost", "0.0.0.0", "127.0.0.1", "my-dev-env.local"]
 
 3. Add the following configuration to the ``devServer`` section of ``webpack/dev.config.js`` ::
 
-  client: {
-    webSocketURL: 'auto://0.0.0.0:0/ws', // note the `:0` after `0.0.0.0`
-  },
+    client: {
+      webSocketURL: 'auto://0.0.0.0:0/ws', // note the `:0` after `0.0.0.0`
+    },
 
 
 Rebuild your ``docker`` application. ::
 
-  $ docker compose -f docker-compose.local.yml up -d --build
+    $ docker compose -f docker-compose.local.yml up -d --build
 
 Go to your browser and type in your URL bar ``https://my-dev-env.local``.
 

diff --git a/docs/developing-locally.rst → ...-local-development/developing-locally.rst b/docs/developing-locally.rst → ...-local-development/developing-locally.rst
@@ -24,8 +24,7 @@ First things first.
 
     $ source <virtual env path>/bin/activate
 
-#.
-    .. include:: generate-project-block.rst
+#. .. include:: generate-project-block.rst
 
 #. Install development requirements: ::
 
@@ -219,7 +218,7 @@ The project comes with a simple task for manual testing purposes, inside `<proje
 
 You can also use Django admin to queue up tasks, thanks to the `django-celerybeat`_ package.
 
-.. _Getting started with Redis guide: https://redis.io/docs/getting-started/
+.. _Getting started with Redis: https://redis.io/docs/getting-started/
 .. _Celery Workers Guide: https://docs.celeryq.dev/en/stable/userguide/workers.html
 .. _django-celerybeat: https://django-celery-beat.readthedocs.io/en/latest/
 

diff --git a/docs/generate-project-block.rst → ...al-development/generate-project-block.rst b/docs/generate-project-block.rst → ...al-development/generate-project-block.rst
diff --git a/docs/deployment-on-heroku.rst → docs/3-deployment/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst → docs/3-deployment/deployment-on-heroku.rst
diff --git a/docs/deployment-on-pythonanywhere.rst → ...ployment/deployment-on-pythonanywhere.rst b/docs/deployment-on-pythonanywhere.rst → ...ployment/deployment-on-pythonanywhere.rst
diff --git a/docs/deployment-with-docker.rst → docs/3-deployment/deployment-with-docker.rst b/docs/deployment-with-docker.rst → docs/3-deployment/deployment-with-docker.rst
diff --git a/docs/mailgun.rst → docs/3-deployment/mailgun.rst b/docs/mailgun.rst → docs/3-deployment/mailgun.rst
diff --git a/docs/docker-postgres-backups.rst → docs/4-guides/docker-postgres-backups.rst b/docs/docker-postgres-backups.rst → docs/4-guides/docker-postgres-backups.rst
diff --git a/docs/document.rst → docs/4-guides/document.rst b/docs/document.rst → docs/4-guides/document.rst
diff --git a/docs/linters.rst → docs/4-guides/linters.rst b/docs/linters.rst → docs/4-guides/linters.rst
diff --git a/docs/testing.rst → docs/4-guides/testing.rst b/docs/testing.rst → docs/4-guides/testing.rst
diff --git a/docs/websocket.rst → docs/4-guides/websocket.rst b/docs/websocket.rst → docs/4-guides/websocket.rst
diff --git a/docs/faq.rst → docs/5-help/faq.rst b/docs/faq.rst → docs/5-help/faq.rst
diff --git a/docs/troubleshooting.rst → docs/5-help/troubleshooting.rst b/docs/troubleshooting.rst → docs/5-help/troubleshooting.rst
diff --git a/docs/6-about/contributing.md b/docs/6-about/contributing.md
@@ -0,0 +1,3 @@
+```{include} ../../CONTRIBUTING.md
+
+```
diff --git a/docs/maintainer-guide.md → docs/6-about/maintainer-guide.md b/docs/maintainer-guide.md → docs/6-about/maintainer-guide.md
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,28 +7,51 @@ Powered by Cookiecutter_, Cookiecutter Django is a project template for jumpstar
 
 .. _cookiecutter: https://github.com/cookiecutter/cookiecutter
 
-Contents
---------
+.. toctree::
+   :maxdepth: 2
+   :caption: Getting Started
+
+   1-getting-started/project-generation-options
+   1-getting-started/settings
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Local Development
+
+   2-local-development/developing-locally
+   2-local-development/developing-locally-docker
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Deployment
+
+   3-deployment/deployment-on-pythonanywhere
+   3-deployment/deployment-on-heroku
+   3-deployment/deployment-with-docker
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Guides
+
+   4-guides/docker-postgres-backups
+   4-guides/linters
+   4-guides/testing
+   4-guides/document
+   4-guides/websocket
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Help
+
+   5-help/faq
+   5-help/troubleshooting
 
 .. toctree::
    :maxdepth: 2
+   :caption: About
 
-   project-generation-options
-   developing-locally
-   developing-locally-docker
-   settings
-   linters
-   testing
-   document
-   deployment-on-pythonanywhere
-   deployment-on-heroku
-   deployment-with-docker
-   docker-postgres-backups
-   websocket
-   faq
-   troubleshooting
-   contributing
-   maintainer-guide
+   6-about/contributing
+   6-about/maintainer-guide
 
 Indices and tables
 ------------------