You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Sphinx to GitHub Pages
3.0beta
Pre-release
Help you deploying your Sphinx documentation to Github Pages.
Warning
v3 is in beta and subject to change, use v2 if you need a stable version.
Create workflow:
name: Deploy Sphinx documentation to Pages # Runs on pushes targeting the default branch on: push: branches: [master] jobs: pages: runs-on: ubuntu-20.04 environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} permissions: pages: write id-token: write steps: - id: deployment uses: sphinx-notes/pages@v3
Input | Default | Required | Description |
documentation_path |
./docs |
false | Path to Sphinx source files |
requirements_path |
./docs/requirements.txt |
false | Path to to requirements file |
python_version |
3.10 |
false | Version of Python |
sphinx_version |
5.3 |
false | Version of Sphinx |
cache |
false |
false | Enable cache to speed up documentation building |
Output | Description |
page_url |
URL to deployed GitHub 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.