diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 138c9ec..a4060e5 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -7,6 +7,13 @@ on: - "documentation.yml" - "docs/**.md" - "docs/assets/**" + pull_request: + branches: + - main + paths: + - "documentation.yml" + - "docs/**.md" + - "docs/assets/**" jobs: publish_docs: @@ -37,32 +44,34 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} CONFIG_FILE: docs/mkdocs.yml REQUIREMENTS: requirements.txt - generate_pdf: - name: 📖 Publish docs as PDF - runs-on: ubuntu-latest - steps: - - name: Checkout 🛒 - uses: actions/checkout@v3 - - name: Install dependencies - uses: timlinux/pip-action@v1 - with: - packages: | - mkdocs-material - qrcode - mkdocs-mermaid2-plugin - - name: Create Mkdocs Config 🚀 - working-directory: ./docs - run: ./create-mkdocs-pdf-config.sh - - name: Build PDF 📃 - uses: kartoza/mkdocs-deploy-build-pdf@master - # Uses orzih's mkdocs PDF builder - # https://github.com/orzih/mkdocs-with-pdf - env: - CONFIG_FILE: docs/mkdocs.yml - EXTRA_PACKAGES: build-base - #REQUIREMENTS: folder/requirements.txt - - name: Upload PDF Artifact ⚡ - uses: actions/upload-artifact@v4 - with: - name: docs - path: docs/pdfs \ No newline at end of file +# TODO: +# Fix this +# generate_pdf: +# name: 📖 Publish docs as PDF +# runs-on: ubuntu-latest +# steps: +# - name: Checkout 🛒 +# uses: actions/checkout@v3 +# - name: Install dependencies +# uses: timlinux/pip-action@v1 +# with: +# packages: | +# mkdocs-material +# qrcode +# mkdocs-mermaid2-plugin +# - name: Create Mkdocs Config 🚀 +# working-directory: ./docs +# run: ./create-mkdocs-pdf-config.sh +# - name: Build PDF 📃 +# uses: kartoza/mkdocs-deploy-build-pdf@master +# # Uses orzih's mkdocs PDF builder +# # https://github.com/orzih/mkdocs-with-pdf +# env: +# CONFIG_FILE: docs/mkdocs.yml +# EXTRA_PACKAGES: build-base +# #REQUIREMENTS: folder/requirements.txt +# - name: Upload PDF Artifact ⚡ +# uses: actions/upload-artifact@v4 +# with: +# name: docs +# path: docs/pdfs \ No newline at end of file diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml index 1e03efe..e54aab3 100644 --- a/docs/mkdocs-base.yml +++ b/docs/mkdocs-base.yml @@ -32,11 +32,11 @@ markdown_extensions: base_path: . - admonition - tables - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:mermaid2.fence_mermaid_custom +# - pymdownx.superfences: +# custom_fences: +# - name: mermaid +# class: mermaid +# format: !!python/name:mermaid2.fence_mermaid_custom - pymdownx.emoji: emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_index: !!python/name:material.extensions.emoji.twemoji diff --git a/docs/requirements.txt b/docs/requirements.txt index a97d089..330f9c3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,7 @@ -mkdocs-with-pdf -mkdocs-bootswatch mkdocs-mermaid2-plugin mkdocs-material +mkdocs-with-pdf +mkdocs-bootswatch mdx_gh_links mkdocs-pdf-export-plugin mkdocstrings-python diff --git a/docs/src/developer/django/architecture-overview.md b/docs/src/developer/django/architecture-overview.md index 191f627..cff57b7 100644 --- a/docs/src/developer/django/architecture-overview.md +++ b/docs/src/developer/django/architecture-overview.md @@ -26,14 +26,4 @@ Django React Base is built on a modern web stack template that leverages the pow ### Architecture Diagram -```mermaid -graph TD - PostgreSQL["PostgreSQL"] - Docker["Docker"] - Django["Django / GeoDjango"] - - Docker --> Django - Docker --> PostgreSQL - Docker --> Celery --> PostgreSQL - Redis --> Celery -``` +To be populated \ No newline at end of file diff --git a/docs/src/developer/index.md b/docs/src/developer/index.md index 4675e41..437626c 100644 --- a/docs/src/developer/index.md +++ b/docs/src/developer/index.md @@ -21,7 +21,7 @@ Each component serves a different purpose. - **[Django application](django/architecture-overview.md)**: Contains the main Django codebase, organized into the **deployment** and **django_project** folders. - **Playwright**: Located in the **playwright** folder. Contains all end-to-end tests for the application and is integrated into the GitHub workflow. -- **Documentation**: Located in the **docs** folder. Contains all project documentation, which is also built in the GitHub workflow. +- **Documentation**: Located in the **docs** folder. Contains all project documentation, which is being built in the GitHub workflow. ### Repo Components