Example for Sphinx projectΒΆ

There is a repo mydoc, it is Sphinx documentation source.

  1. add file ./.github/workflows/example-sphinx.yml

    on: [push]
    
    jobs:
      build:
        name: Sphinx Pages Test
        runs-on: ubuntu-latest
        steps:
          - uses: seanzhengw/sphinx-pages@master
            id: sphinx-pages
            with:
              github_token: ${{ secrets.GITHUB_TOKEN }}
              create_readme: true
    
  2. commit

  3. push

  4. wait for the workflow