Help you deploying your Sphinx documentation to Github Pages.

This action only help you build and commit Sphinx documentation to gh-pages, branch. So we need some other actions:

• action/setup-python for installing python and pip
• actions/checkout for checking out git repository
• ad-m/github-push-action for pushing site to remote

So your workflow file should be:

name: Pages
on:
  push:
    branches:
    - master
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/setup-python@v2
    - uses: actions/checkout@master
      with:
        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
    - name: Build and Commit
      uses: sphinx-notes/pages@v2
    - name: Push changes
      uses: ad-m/github-push-action@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages

The following repository's pages are built by this action:

• https://github.com/SilverRainZ/bullet
• https://github.com/sphinx-notes/pages
• https://github.com/sphinx-notes/any
• https://github.com/sphinx-notes/snippet
• https://github.com/sphinx-notes/lilypond
• https://github.com/sphinx-notes/strike
• ...

You can found the workflow file in their repository.

Use Sphinx confval html_extra_path.