diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml deleted file mode 100644 index 809c4dc..0000000 --- a/.github/workflows/build.yaml +++ /dev/null @@ -1,37 +0,0 @@ -name: Build and Deploy MkDocs - -on: - push: - branches: - - docs/mkdocs - - main - -permissions: - contents: write - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v3 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: 3.x # Use the latest version of Python 3 - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install mkdocs-material - - - name: Build MkDocs - run: mkdocs build --site-dir public - - - name: Deploy to GitHub Pages - uses: JamesIves/github-pages-deploy-action@v4 - with: - branch: gh-pages - folder: public diff --git a/.github/workflows/deploy_documentation.yaml b/.github/workflows/deploy_documentation.yaml index 809c4dc..eb8f895 100644 --- 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 new file mode 100644 index 0000000..7bec0ac --- /dev/null +++ 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 b/docs/api/usage.md similarity index 100% rename from docs/API/Usage & Documentation.md rename to docs/api/usage.md diff --git a/docs/Development Setup Guide/Database Setup.md b/docs/development_guide/database_setup.md similarity index 100% rename from docs/Development Setup Guide/Database Setup.md rename to docs/development_guide/database_setup.md diff --git a/docs/Development Setup Guide/Making Migrations & Adding Seed Data.md b/docs/development_guide/migrations.md similarity index 100% rename from docs/Development Setup Guide/Making Migrations & Adding Seed Data.md rename to docs/development_guide/migrations.md diff --git a/docs/Development Setup Guide/Python Environment Setup.md b/docs/development_guide/python_setup.md similarity index 100% rename from docs/Development Setup Guide/Python Environment Setup.md rename to docs/development_guide/python_setup.md diff --git a/docs/Development Setup Guide/Running Server & Creating an Admin Account.md b/docs/development_guide/running_first_time.md similarity index 100% rename from docs/Development Setup Guide/Running Server & Creating an Admin Account.md rename to docs/development_guide/running_first_time.md diff --git a/mkdocs.yaml b/mkdocs.yaml index 35e7f60..d5d970e 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -31,6 +31,7 @@ theme: plugins: - search + - awesome-pages markdown_extensions: - pymdownx.arithmatex: