uibcdf/Sphinx docs to GitHub Pages
Automatic Sphinx html docs compilation and deployment through the gh-pages branch.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| branch | Name of the branch where the sphinx documentation is located | no | main |
| branch-checkout-args | Arguments to pass to `git checkout`: `git checkout ${checkout-args} "${branch}"` | no | "" |
| dir_docs | Path where the sphinx documentation is located | no | docs |
| sphinx-apidoc | With sphinx-apidoc | no | true |
| sphinx-apidoc-exclude | Files/directories to exclude from sphinx-apidoc | — | *setup* tests* |
| sphinx-apidoc-opts | Options for sphinx-apidoc (default outputs to dir_docs and searches for modules one level up) | — | -o . ../ |
| sphinx-opts | Compilation options for sphinx-build | no | "" |
Outputs
no outputs