diff --git a/.github/workflows/mkdocs-deploy.yml b/.github/workflows/mkdocs-deploy.yml new file mode 100644 index 0000000..cafa313 --- /dev/null +++ b/.github/workflows/mkdocs-deploy.yml @@ -0,0 +1,36 @@ +name: Deploy EllieBot Docs + +on: + push: + branches: ["v6"] + paths: + - 'docs/**' + workflow_dispatch: + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.12" + cache: 'pip' + cache-dependency-path: 'docs/mkdocs-requirements.txt' + + - name: Install project dependencies + run: pip install -r docs/mkdocs-requirements.txt + + - name: Build the site with MkDocs + working-directory: ./docs + run: mkdocs build --strict + + - name: Deploy to GitHub Pages + working-directory: ./docs + run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/docs/mkdocs-requirements.txt b/docs/mkdocs-requirements.txt new file mode 100644 index 0000000..0696a31 --- /dev/null +++ b/docs/mkdocs-requirements.txt @@ -0,0 +1,3 @@ +mkdocs-material~=9.6 +mkdocs~=1.6 +mkdocs-exclude~=1.0 \ No newline at end of file