compas-dev/compas-actions.docs
Build docs for COMPAS or its plugins
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| doc_url | custom url of the docs site, otherwise default gh-pages url of the repo | no | — |
| github_token | the github token for publishing docs | yes | — |
| test_docs | whether to test docstrings in this action. | no | true |
| python | which python version to build docs with | no | 3.10 |
| use_conda | whether to build docs with conda | no | false |
| use_virtual_display | allow using virtual display on linux when matplotlab is imported | no | false |
| use_latex | install dependencies for LaTex | no | false |
| generator | which documentation generator to use (sphinx or mkdocs) | no | sphinx |
| extras | comma-separated list of optional dependencies to install (e.g. dev,docs,mkdocs) | no | dev |
Outputs
| name | description |
|---|---|
| commit_type | The type of this commit: main, pull or tag |
| current_version | The version number if the commit is tag |
| subfolder | The subfolder name where the docs are built to |