Skip to content

Commit

Permalink
docs changed
Browse files Browse the repository at this point in the history
  • Loading branch information
ZibraMax committed Mar 21, 2021
1 parent a0b74cc commit 510bfaf
Showing 1 changed file with 53 additions and 54 deletions.
107 changes: 53 additions & 54 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,59 +1,58 @@
name: "Docs"
on:
release:
types: [created]
release:
types: [created]

jobs:
build:
build:
runs-on: ubuntu-latest

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 "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
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.TOKENGHPAGES }}
# ===============================
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: docs/_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 "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
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.TOKENGHPAGES }}
# ===============================

0 comments on commit 510bfaf

Please sign in to comment.