Move docs to main repo (#2583) #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Publish docs via GitHub Pages | |
on: | |
workflow_dispatch: | |
push: | |
branches: [1.20.1] | |
paths: ['docs/**'] | |
jobs: | |
build: | |
name: build docs | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: './docs' | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
ref: '1.20.1' | |
sparse-checkout: './docs' | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.11' | |
cache: 'pip' | |
- run: pip install -r ./requirements.txt | |
- uses: actions/cache@v4 | |
with: | |
key: 'mkdocs-cache' | |
path: './docs/.cache' | |
- name: Build static files | |
id: mkdocs | |
run: mkdocs build | |
- name: Upload pages as artifact | |
id: artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: './docs/site/' | |
deploy: | |
runs-on: ubuntu-latest | |
needs: build | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Deploy Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |