docs: update structure

Author: Paul-B98

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 {
-	"name": "Python project",
+	"name": "Django project",
 	"dockerComposeFile": "docker-compose.yml",
-	"service": "project",
+	"service": "django",
 	"workspaceFolder": "/workspaces",
 	"remoteUser": "vscode",
 	"mounts": [
@@ -22,7 +22,8 @@
 				"GitHub.copilot-chat",
 				"ms-vsliveshare.vsliveshare",
 				"GitHub.vscode-pull-request-github",
-				"github.vscode-github-actions"
+				"github.vscode-github-actions",
+				"redhat.vscode-yaml"
 			],
 			"settings": {
 				"[python]": {

.devcontainer/docker-compose.yml

@@ -1,8 +1,8 @@
 version: '3.8'
 
 services:
-  project:  # TODO change this to your project name
-    container_name: project  # TODO change this to your project name
+  django:  # TODO change this to your project name
+    container_name: django  # TODO change this to your project name
     extra_hosts:
       - host.docker.internal:host-gateway
     init: true

docs/docs/getting_started/basic_usage.md docs/getting_started/basic_usage.mddocs/docs/getting_started/basic_usage.md renamed to docs/getting_started/basic_usage.md

@@ -1,52 +1,59 @@
 site_name: project_name
-docs_dir: docs/docs
+docs_dir: docs
 nav:
-- Getting Started:
-  - Package Overview: 'getting_started/overview.md'
-  - Installation: 'getting_started/installation.md'
-  - Basic Usage: 'getting_started/basic_usage.md'
-  - Contributing: 'getting_started/contributing.md'
-# - User Guide:
-- API Reference: reference/
-extra_css:
-- css/code_select.css
+  - Getting Started:
+      - Package Overview: "getting_started/overview.md"
+      - Installation: "getting_started/installation.md"
+      - Basic Usage: "getting_started/basic_usage.md"
+      - Contributing: "getting_started/contributing.md"
+  # - User Guide:
+  - API Reference: reference/
+
+copyright: Copyright © 2023 Paul-B98
+
 theme:
   name: material
-  repo_url: 'https://github.com/Paul-B98/python-project-template'
+  repo_url: "https://github.com/Paul-B98/python-project-template"
   features:
     - navigation.tabs
     - navigation.footer
+
 extra:
   social:
-  - icon: fontawesome/brands/github
-    link: https://github.com/Paul-B98/python-project-template
-  - icon: fontawesome/brands/python
-    link: https://pypi.org/project/ # TODO change this to your project name
-copyright: Copyright © 2023 AIDH-MS
+    - icon: fontawesome/brands/github
+      link: https://github.com/Paul-B98/python-project-template
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/project/ # TODO change this to your project name
+
+extra_css:
+  - assets/css/code_select.css
+  - assets/css/fonts.css
 
 markdown_extensions:
-- attr_list
-- pymdownx.highlight:
-    linenums: true
-    use_pygments: true
-    pygments_lang_class: true
-- pymdownx.superfences
-- pymdownx.extra
-- footnotes
+  - attr_list
+  - pymdownx.highlight:
+      linenums: true
+      use_pygments: true
+      pygments_lang_class: true
+  - pymdownx.superfences
+  - pymdownx.extra
+  - footnotes
+  - pymdownx.arithmatex:
+      generic: true
 
 plugins:
-- search:
-- macros:
-    include_dir: ./
-- gen-files:
-    scripts:
-      - docs/scripts/gen_ref_pages.py
-- literate-nav:
-    nav_file: SUMMARY.md
-- section-index
-- mkdocstrings:
-    handlers:
-      python:
-        paths: ['project_name']
-        options:
-          docstring_style: numpy
+  - search:
+  - macros:
+      include_dir: ./
+  - gen-files:
+      scripts:
+        - docs/scripts/gen_ref_pages.py
+  - literate-nav:
+      nav_file: SUMMARY.md
+  - section-index
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: ["project_name"]
+          options:
+            docstring_style: numpy