generated from actions/container-action
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f38c3c7
commit fd7234d
Showing
2 changed files
with
26 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,20 @@ | ||
# Container Action Template | ||
# doc-build github action | ||
|
||
To get started, click the `Use this template` button on this repository [which will create a new repository based on this template](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/). | ||
This action build [sphinx](https://www.sphinx-doc.org/) documentation. | ||
|
||
For info on how to build your first Container action, see the [toolkit docs folder](https://github.com/actions/toolkit/blob/master/docs/container-action.md). | ||
## Inputs | ||
|
||
### `docs` | ||
|
||
**Required** The location of the documentation source to build. Default `"docs"`. | ||
|
||
### `dest` | ||
|
||
**Required** The destination directory. Default `"build"`. | ||
|
||
## Example usage | ||
|
||
uses: andreasofthings/doc-build@v13 | ||
with: | ||
docs: 'docs' | ||
dest: 'build' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters