actions-marketplace-validations/Sphinx Pages
Builds GitHub Pages with Sphinx
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | Token for the repo. Can be passed in using $\{{ secrets.GITHUB_TOKEN }} | yes | — |
| create_readme | Auto create a README.md file at branch gh-pages root with repo/branch/commit links | — | false |
| source_dir | Path to documentation source files that relative to project root | — | . |
| install_extensions | Install Sphinx extensions listed in $source_dir/requirements.txt | — | true |
Outputs
| name | description |
|---|---|
| name | Author name |
| Author email | |
| docs_sha | Sphinx source sha |
| docs_sha8 | Sphinx source short sha |