Skip to content

Commit

Permalink
Update gh-pages workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
TDKorn committed Oct 15, 2023
1 parent 907be72 commit 1255f76
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 31 deletions.
42 changes: 13 additions & 29 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: "Deploy Sphinx gh-pages"
on:
on:
push:
branches:
- main
Expand All @@ -9,37 +9,21 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1

- uses: ammaraskar/sphinx-action@master
- uses: actions/checkout@v3
with:
pre-build-command: "python -m pip install --upgrade my-magento"
docs-folder: "docs/"
fetch-depth: 0

# Create an artifact of the html output.
- uses: actions/upload-artifact@v1
with:
name: DocumentationHTML
path: docs/build/html/
- 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
# Publish built docs to gh-pages branch.
# ===============================
- name: Commit documentation changes
run: |
git clone https://github.com/tdkorn/my-magento.git --branch gh-pages --single-branch gh-pages
cp -r docs/build/html/* gh-pages/docs/
cd gh-pages
touch docs/.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
force_orphan: true
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ sphinx_rtd_theme>=0.5.2
docutils<0.17
myst-nb>=0.17.1
sphinx-sitemap>=2.5.0
sphinx_github_style>=1.0.2
sphinx_readme>=0.2.1
sphinx-github_style>=1.0.2
sphinx-readme>=0.2.1

0 comments on commit 1255f76

Please sign in to comment.