Added files for the github mirror
This commit is contained in:
parent
e0ff50b5cd
commit
3f6468f374
2 changed files with 39 additions and 0 deletions
36
.github/workflows/mkdocs-deploy.yml
vendored
Normal file
36
.github/workflows/mkdocs-deploy.yml
vendored
Normal file
|
@ -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
|
3
docs/mkdocs-requirements.txt
Normal file
3
docs/mkdocs-requirements.txt
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
mkdocs-material~=9.6
|
||||||
|
mkdocs~=1.6
|
||||||
|
mkdocs-exclude~=1.0
|
Loading…
Add table
Add a link
Reference in a new issue