generated from ApeWorX/project-template
-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
46 additions
and
707 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,41 @@ | ||
name: Docs | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
release: | ||
types: [released] | ||
pull_request: | ||
types: [opened, synchronize] | ||
push: | ||
branches: [main] | ||
release: | ||
types: [released] | ||
pull_request: | ||
types: [opened, synchronize] | ||
|
||
concurrency: | ||
# Cancel older, in-progress jobs from the same PR, same workflow. | ||
# use run_id if the job is triggered by a push to ensure | ||
# push-triggered jobs to not get canceled. | ||
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: "3.10" | ||
|
||
- name: Install Dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install .[doc] | ||
- name: Build HTML artifact | ||
run: python build_docs.py | ||
|
||
- name: Upload HTML artifact | ||
uses: actions/upload-artifact@v1 | ||
with: | ||
name: DocumentationHTML | ||
path: docs/_build/ape-alchemy | ||
|
||
- name: Commit and publish documentation changes to gh-pages branch | ||
run: | | ||
if [[ "${GITHUB_EVENT_NAME}" =~ "pull_request" ]]; then | ||
echo "skipping 'git commit' step for PR" | ||
else | ||
git clone https://github.com/${GITHUB_REPOSITORY} --branch gh-pages --single-branch gh-pages | ||
cp -r docs/_build/ape-alchemy/* gh-pages/ | ||
cd gh-pages | ||
touch .nojekyll | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "GitHub Action" | ||
git add . | ||
git commit -m "Update documentation" -a || true | ||
fi | ||
- name: Push changes | ||
uses: ad-m/github-push-action@master | ||
if: ${{ github.event_name != 'pull_request' }} | ||
with: | ||
branch: gh-pages | ||
directory: gh-pages | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
docs: | ||
runs-on: ubuntu-latest | ||
|
||
permissions: | ||
contents: write | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.10" | ||
|
||
- name: Install Dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install .[doc] | ||
- name: Ape Docs | ||
uses: apeworx/sphinx-ape@main | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} |
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.