totaldebug/Sphinx Publish Action
A GitHub Action to build and publish Jekyll sites to GitHub Pages
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | The GITHUB_TOKEN secret | no | — |
| sphinx_env | The Sphinx environment to build | no | — |
| sphinx_src | The Sphinx website source directory | no | — |
| sphinx_build_options | Additional Sphinx build arguments (see https://www.sphinx-doc.org/en/master/man/sphinx-build.html) | no | — |
| target_branch | The target branch name the site gets pushed to | no | — |
| target_path | The relative path where the site gets pushed to | no | — |
| build_only | Will build the Sphinx site without publishing it | no | — |
| keep_history | Do not overwrite whatever was already published on the target branch | no | — |
| pre_build_commands | Commands to run prior to build and deploy. Useful for ensuring build dependencies are up to date or installing new dependencies. For example, use `apk --update add imagemagick` to install ImageMagick. | no | — |
| cname | contents of the CNAME file | no | — |
Outputs
no outputs