sphinx-notes/Sphinx to GitHub Pages
GitHub Action to deploy Sphinx documentation to GitHub Pages
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| documentation_path | Path to Sphinx source files | no | ./docs |
| requirements_path | Path to requirements file, used in `pip install -r XXX` command | no | ./docs/requirements.txt |
| pyproject_extras | Extras of Requirement Specifier, used in `pip install .[XXX]` command | no | docs |
| python_version | Version of Python | no | 3.12 |
| sphinx_version | Version of Sphinx | no | "" |
| cache | Enable cache to speed up documentation building | no | false |
| sphinx_build_options | Additional options passed to sphinx-build | no | "" |
| checkout | Whether to automatically checkout the repository, if false, user need to do it byself | no | true |
| publish | Whether to automatically publish the pages, if false, user need to manually publish by self | no | true |
Outputs
| name | description |
|---|---|
| page_url | URL to deployed GitHub Pages, only available when option publish is set to true |
| artifact | Directory where artifact (HTML documentation) is stored, user can use it to deploy GitHub Pages manually |