institutefordiseasemodeling/Sphinx Azure Upload
Builds HTML and Text docs then uploads to Azure Blob storage
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Aug 18, 2023
- License
- MIT
Pinned Snippet
uses: institutefordiseasemodeling/idmbuildthedocs@2aa15a1f211414a7a52048d96555fadc731b0962 # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| working_directory | Documents root folder name | no | docs |
| blob_endpoint | Azure blob endpoint | yes | — |
| target_location | Target Location and repo identifier, i.e. idm/repository | yes | — |
| blob_container_name | Azure container name | yes | — |
| index_html | Landing page name for your documents project, it is by default index.html | no | index.html |
| make_text | determines if the sphinx build TAR file with the text file is generated | — | true |
| tar_file_name | Unique TAR file name | yes | — |
| tar_target_folder | Tar destination Folder Name | no | download/tar |
| service_principal_credentials | BLOB_JSON_SERVICE_PRINCIPAL_CREDENTIALS | yes | — |
| account_name | Azure Account name | yes | — |
| cdn_profile_name | Blob container CDN web profile name | yes | — |
| cdn_endpoint_name | Blob cdn end point name | yes | — |
| resource_group | Resource group name | yes | — |
| pr_update_token | Github token | yes | — |
Outputs
| name | description |
|---|---|
| yourlink | This is the entry point to the generated documents |