Skip to content

Commit

Permalink
Update docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
TDKorn committed Aug 25, 2023
1 parent c5e80ed commit a3ec5fd
Showing 1 changed file with 14 additions and 28 deletions.
42 changes: 14 additions & 28 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,23 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1

- uses: ammaraskar/sphinx-action@master
- uses: actions/checkout@v3
with:
docs-folder: "docs/"
pre-build-command: "pip install -r requirements.txt"
fetch-depth: 0

- name: Build doc
run: |
sudo apt-get --allow-releaseinfo-change update -y
sudo apt-get install -y git make sphinx
pip install -r requirements.txt
pip install -r docs/requirements.txt
make -C docs html
# Create an artifact of the html output.
- uses: actions/upload-artifact@v1
with:
name: DocumentationHTML
path: docs/build/html/
# Publish built docs to gh-pages branch.
# ===============================
- name: Commit documentation changes
run: |
git clone https://github.com/tdkorn/sphinx-github-style.git --branch gh-pages --single-branch gh-pages
cp -r docs/build/html/* gh-pages/docs/
cd gh-pages
touch .nojekyll
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore
# that.
- name: Push changes
uses: ad-m/github-push-action@master
uses: peaceiris/actions-gh-pages@v3
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
# ===============================
publish_dir: ./docs/build/html
destination_dir: docs
enable_jekyll: false

0 comments on commit a3ec5fd

Please sign in to comment.