Update README.md #31
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Publish Sphinx Docs to GitHub Pages | |
| on: [push] | |
| # see: https://sphinx-notes.github.io/pages/ | |
| # see: https://github.com/marketplace/actions/sphinx-to-github-pages | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| 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@master | |
| with: | |
| # path to conf.py directory | |
| documentation_path: docs/source | |
| - name: Push changes if refs/tags | |
| if: startsWith(github.ref, 'refs/tags') | |
| uses: ad-m/github-push-action@master | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages |