Skip to content

Commit

Permalink
-# Please enter the commit message for your changes. Lines starting
Browse files Browse the repository at this point in the history
  • Loading branch information
haeussma committed Nov 29, 2023
1 parent aa45be6 commit 02a6edc
Showing 1 changed file with 22 additions and 56 deletions.
78 changes: 22 additions & 56 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -1,61 +1,27 @@
name: CI
name: documentation

on:
push:
branches:
- docs
on: [push, pull_request, workflow_dispatch]

jobs:
build:
permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
# Standard drop-in approach that should work for most people.
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
# Example of using a custom build-command.
# - uses: ammaraskar/sphinx-action@master
# with:
# build-command: "sphinx-build -b html . _build"
# docs-folder: "docs2/"
# # Grabbing custom dependencies and building as a pdf.
# - uses: ammaraskar/sphinx-action@master
# with:
# pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended"
# build-command: "make latexpdf"
# docs-folder: "docs2/"
# Great extra actions to compose with:
# Create an artifact of the html output.
- uses: actions/upload-artifact@v1
with:
name: DocumentationHTML
path: docs/_build/html/
# Create an artifact out of the previously built pdf.
# - uses: actions/upload-artifact@v1
# with:
# name: Documentation
# path: docs2/_build/latex/pdfexample.pdf
# Publish built docs to gh-pages branch.
# ===============================
- name: Commit documentation changes
run: |
git clone https://github.com/ammaraskar/sphinx-action-test.git --branch gh-pages --single-branch gh-pages
cp -r docs/_build/html/* 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
# The above command will fail if no changes were present, so we ignore
# that.
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
# ===============================
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
run: |
sphinx-build doc _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true

0 comments on commit 02a6edc

Please sign in to comment.