usnistgov/Docs4NIST
Deploys Sphinx-built documentation to https://pages.nist.gov
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/ |
| pages-branch | The branch linked to your documentation server. | — | nist-pages |
| pages-url | URL of web server for served documentation. | — | https://pages.nist.gov |
| formats | Type(s) of output desired in addition to html ('pdf', and/or 'epub') | no | "" |
| build-html-command | The command used to build your html documentation. | no | make html |
| build-epub-command | The command used to build your ePUB documentation. | no | make epub |
| build-pdf-command | The command used to build your PDF documentation. | no | make latexpdf |
| 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 | — |
| apt-packages | List of APT packages to install. | no | "" |
| pip-requirements | The path to the pip requirements file, relative to the root of the project. | no | — |
| conda-environment | The path to the Conda environment file, relative to the root of the project. | no | — |
| push-pulls-pages | Whether the results of pull requests should be pushed to `pages-branch`. | — | false |
| insert-header-footer | Whether to insert the NIST branding headers and footers (which are incompatible with sphinx_rtd_theme). | — | true |
| hidden | Whether to remove current revision from dropdown version menu. | — | false |
Outputs
no outputs