Commit documentation changes (html) #9
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: Commit documentation changes (html) | |
on: workflow_dispatch | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.9' | |
- name: Install dependencies | |
run: | | |
python -m pip install -r requirements.txt | |
- name: make the sphinx docs | |
run: | | |
make -C docs clean | |
# sphinx-apidoc -f -o docs/source . -H Test -e -t docs/source/_templates | |
make -C docs html | |
- name: Init new repo in dist folder and commit generated files | |
run: | | |
cd docs/build/html/ | |
touch .nojekyll | |
git add -A | |
git config --local user.email "action@github.com" | |
git config --local user.name "GitHub Action" | |
git commit -m 'deploy' | |
- name: Force push to destination branch | |
uses: ad-m/github-push-action@master | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
branch: rtd-pages | |
directory: docs/build/html | |
force_with_lease: true |