Update to documentation structure and ordering

johnhalz · Sep 8, 2024 · 422fe8c · 422fe8c
1 parent 9f682e6
commit 422fe8c
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 38 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
diff --git a/.github/workflows/deploy_documentation.yaml b/.github/workflows/deploy_documentation.yaml
@@ -25,7 +25,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install mkdocs-material
+        pip install mkdocs-material mkdocs-awesome-pages-plugin
 
     - name: Build MkDocs
       run: mkdocs build --site-dir public

diff --git a/docs/.pages b/docs/.pages
@@ -0,0 +1,11 @@
+nav:
+  - Introduction: index.md
+  - Database:
+      - Database Schema: database/schema.md
+  - API:
+      - API Usage: api/usage.md
+  - Development Setup Guide:
+      - Database Setup: development_guide/database_setup.md
+      - Python Environment Setup: development_guide/python_setup.md
+      - Making Migrations & Adding Seed Data: development_guide/migrations.md
+      - Running Server & Creating an Admin Account: development_guide/running_first_time.md
diff --git a/docs/API/Usage & Documentation.md → docs/api/usage.md b/docs/API/Usage & Documentation.md → docs/api/usage.md
diff --git a/...Development Setup Guide/Database Setup.md → docs/development_guide/database_setup.md b/...Development Setup Guide/Database Setup.md → docs/development_guide/database_setup.md
diff --git a/...e/Making Migrations & Adding Seed Data.md → docs/development_guide/migrations.md b/...e/Making Migrations & Adding Seed Data.md → docs/development_guide/migrations.md
diff --git a/...t Setup Guide/Python Environment Setup.md → docs/development_guide/python_setup.md b/...t Setup Guide/Python Environment Setup.md → docs/development_guide/python_setup.md
diff --git a/...ing Server & Creating an Admin Account.md → docs/development_guide/running_first_time.md b/...ing Server & Creating an Admin Account.md → docs/development_guide/running_first_time.md
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -31,6 +31,7 @@ theme:
 
 plugins:
   - search
+  - awesome-pages
 
 markdown_extensions:
   - pymdownx.arithmatex: