chore: delete unnecessary files and update documentation structure #8
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 | |
# execute this workflow automatically when a we push to master | |
on: | |
push: | |
branches: [ main ] | |
jobs: | |
build_docs_job: | |
runs-on: ubuntu-latest | |
env: | |
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v2.3.4 | |
- name: Set up Python | |
uses: actions/setup-python@v2.2.1 | |
with: | |
python-version: 3.9 | |
- name: Install dependencies | |
run: | | |
python -m pip install -U sphinx | |
python -m pip install sphinx-rtd-theme | |
# python -m pip install sphinxcontrib-apidoc | |
python -m pip install sphinx-autoapi | |
- 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/ | |
git init | |
touch .nojekyll | |
git add -A | |
git config --local user.email "action@github.com" | |
git config --local user.name "GitHub Action" | |
git commit -m 'deploy: build docs' | |
- name: Force push to destination branch | |
uses: ad-m/github-push-action@v0.5.0 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
branch: gh-pages | |
force: true | |
directory: ./docs/build/html |