version bump #1
Workflow file for this run
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: Update Docs with Versioning | |
on: | |
push: | |
tags: | |
- '*' | |
workflow_dispatch: | |
permissions: | |
contents: write | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout Repository | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
- name: Install Dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install sphinx | |
- name: Run Sphinx-apidoc | |
run: | | |
cd docs | |
sphinx-apidoc ../src -o ./source | |
- name: Commit and Push to Generated Docs Branch | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
run: | | |
git config --global user.name "github-actions[bot]" | |
git config --global user.email "github-actions[bot]@users.noreply.github.com" | |
git checkout -b generated-docs || git checkout generated-docs | |
git add . | |
git commit -m "Update docs for version $GITHUB_REF_NAME [skip ci]" || echo "No changes to commit" | |
git push origin generated-docs |