Update CHANGELOG #23
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: 📖 Documentation | |
on: | |
push: | |
branches: | |
- master | |
paths: | |
- 'doc/**' | |
- '.github/workflows/publisch-doc.yml' | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Get source code | |
uses: actions/checkout@v2 | |
with: | |
fetch-depth: 0 | |
- name: Set up Python 3.10 | |
uses: actions/[email protected] | |
with: | |
python-version: '3.10' | |
- name: Set up NodeJS (for search index prebuilding) | |
uses: actions/[email protected] | |
with: | |
node-version: '12' | |
- name: Cache project dependencies (pip) | |
uses: actions/[email protected] | |
with: | |
path: ~/.cache/pip | |
key: ${{ runner.os }}-pip-${{ hashFiles('doc/requirements.txt') }} | |
restore-keys: | | |
${{ runner.os }}-pip- | |
${{ runner.os }}- | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip setuptools wheel | |
python -m pip install -r doc/requirements.txt | |
- name: Build HTML | |
run: | | |
make -C doc html | |
- name: Bypass underscore | |
run: touch doc/build/html/.nojekyll | |
- name: Deploy to GitHub Pages | |
uses: JamesIves/[email protected] | |
with: | |
branch: gh-pages | |
folder: doc/build/html | |
token: ${{ secrets.BOT_HUB_TOKEN }} | |
git-config-name: ${{ secrets.BOT_NAME }} | |
git-config-email: ${{ secrets.BOT_MAIL }} |