docs_pages_workflow #4
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: docs_pages_workflow | |
on: | |
push: | |
branches: [ main ] | |
workflow_dispatch: # This line adds the manual trigger option | |
jobs: | |
build_docs_job: | |
runs-on: ubuntu-latest | |
env: | |
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
steps: | |
- name: Checkout | |
uses: actions/[email protected] | |
- name: Set up Python | |
uses: actions/[email protected] | |
with: | |
python-version: 3.9 | |
- name: Install dependencies | |
run: | | |
python -m pip install -U sphinx | |
python -m pip install sphinx-rtd-theme mathjax sphinxcontrib-napoleon numpydoc ipython | |
- name: make the sphinx docs | |
run: | | |
make -C docs clean | |
make -C docs html | |
- name: Init new repo in dist folder and commit | |
run: | | |
cd docs/build/html/ | |
git init | |
touch .nojekyll | |
git add -A | |
git config --global --add safe.directory /github/workspace/docs/build/html | |
git config --local user.email "[email protected]" | |
git config --local user.name "GitHub Action" | |
git commit -m 'deploy' | |
- name: Force push to destination branch | |
uses: ad-m/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
branch: gh-pages | |
force: true | |
directory: ./docs/build/html |