matthiaszepper/Sphinx Build
Builds documentation using Sphinx
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| docs-folder | The folder containing your sphinx docs. | yes | docs/ |
| build-command | The command used to build your documentation. | no | make html |
| pre-build-command | Run before the build command, you can use this to install system level dependencies, for example with "apt-get update -y && apt-get install -y perl" | no | — |
| update | Set this flag to run 'apt update' in the container before starting the sphinx build. | no | false |
| install | A list of additional 'apt' packages to install before running sphinx. (Setting this will force-enable 'update' as well.) | no | — |
| container | Run the build in the named container. Must be one of 'pdflatex', or 'latest'. | no | default |
Outputs
no outputs