This is a Github action that looks for Sphinx documentation folders in your project. It builds the documentation using Sphinx and any errors in the build process are bubbled up as Github status checks.
The main purposes of this action are:
-
Run a CI test to ensure your documentation still builds.
-
Allow contributors to get build errors on simple doc changes inline on Github without having to install Sphinx and build locally.
Create a workflow for the action, for example:
name: "Pull Request Docs Check"
on:
- pull_request
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"-
If you have any Python dependencies that your project needs (themes, build tools, etc) then place them in a requirements.txt file inside your docs folder.
-
If you have multiple sphinx documentation folders, please use multiple
usesblocks.
For a full example repo using this action including advanced usage, take a look at https://github.com/ammaraskar/sphinx-action-test
Some really good actions that work well with this one are
actions/upload-artifact
and ad-m/github-push-action.
You can use these to make built HTML and PDFs available as artifacts:
- uses: actions/upload-artifact@v1
with:
name: DocumentationHTML
path: docs/_build/html/Or to push docs changes automatically to a gh-pages branch:
Code for your workflow
- name: Commit documentation changes
run: |
git clone https://github.com/your_git/repository.git --branch gh-pages --single-branch gh-pages
cp -r docs/_build/html/* gh-pages/
cd gh-pages
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
# the return code.
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}For a full fledged example of this in action take a look at: https://github.com/ammaraskar/sphinx-action-test
If you wish to customize the command used to build the docs (defaults to
make html), you can provide a build-command in the with block. For
example, to invoke sphinx-build directly you can use:
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
build-command: "sphinx-build -b html . _build"If there's system level dependencies that need to be installed for your
build, you can use the pre-build-command argument like so:
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs2/"
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"python -m unittest
Please use black for formatting:
black entrypoint.py sphinx_action tests
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent