cascode-labs/Build sphinx docs
Builds IDS Sphinx documentation
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Jan 2, 2022
- License
- MIT
Pinned Snippet
uses: cascode-labs/build-sphinx-action@6228cefb6c7635eac127fb82ee78cc07e7dc418b # v0.2.3tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| docs_path | The path to the documentation folder from the repo root | no | docs |
| conda_build_env_filepath | Yaml Conda build environment definition file | no | action_default |
| conda_build_env_name | Name of the build conda environment | no | action_default |
| base_env_prefix | The prefix of the base Conda environment for self-hosted runs. | no | /usr/share/miniconda |
| artifact_name | Display name of the documentation artifact | no | documentation |
| package_folder_path | Path to the folder containing the project's package(s) to be installed | no | conda_package |
| package_name | Name of the project's Conda package | no | ${{ github.event.repository.name }} |
Outputs
| name | description |
|---|---|
| filepath | The file path of the generated HTML documentation |