g5t/Versioned Sphinx with Autodoc GH-Pages
Build versioned GitHub Pages with Sphinx
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| create_readme | Auto create a README.md file at branch gh-pages with repo/branch/commit links | no | false |
| source_dir | Directory relative to $\{{ GITHUB_WORKSPACE }} where the repository is checked out | no | — |
| pages_dir | Directory relative to $\{{ GITHUB_WORKSPACE }} where the pages branch is checked out | yes | — |
| is_release | Whether this is a release documentation build | no | false |
| update_git | Update and push the $\{{ pages_dir }} git repositories. `false` is useful for local testing | no | true |
| wheelhouse | Location of pre-built wheel(s) | yes | — |
| package | Name of the pre-built package to install from the wheelhouse | yes | — |
| wheel | Use a pre-built wheel instead of building before installing | no | false |
| html_dir | The destination HTML directory, useful for Pull Request triggered builds | no | unknown |
Outputs
| name | description |
|---|---|
| name | Author name |
| Author email | |
| docs_sha | Sphinx source sha |
| docs_sha8 | Sphinx source short sha |