Skip to content

Commit

Permalink
Merge pull request #50 from hotosm/docs/auto-doc-update-workflows
Browse files Browse the repository at this point in the history
auto-doc: updated workflows docs
  • Loading branch information
spwoodcock authored Jan 23, 2024
2 parents 024ae56 + f447fc4 commit b29f014
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/mkdocs_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ You need to have:

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------- | ------ | -------- | ------------------------------------------- | --------------------------------------------------------------------- |
| <a name="input_doxygen"></a>[doxygen](#input_doxygen) | string | false | | Include doxygen output uploaded to <br>extra-docs-files artifact. |
| <a name="input_image"></a>[image](#input_image) | string | false | `"ghcr.io/hotosm/gh-workflows/mkdocs:main"` | Override the image to build <br>mkdocs. |
| <a name="input_openapi"></a>[openapi](#input_openapi) | string | false | | Include openapi output uploaded to <br>extra-docs-files artifact. |
| <a name="input_stories"></a>[stories](#input_stories) | string | false | | Include story build output uploaded <br>to extra-docs-files artifact. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------------------------------------------------------------- | ------- | -------- | ------------------------------------------- | ----------------------------------------------------------------------------- |
| <a name="input_doxygen"></a>[doxygen](#input_doxygen) | string | false | | Include doxygen output uploaded to <br>extra-docs-files artifact. |
| <a name="input_image"></a>[image](#input_image) | string | false | `"ghcr.io/hotosm/gh-workflows/mkdocs:main"` | Override the image to build <br>mkdocs. |
| <a name="input_keep_extra_files"></a>[keep_extra_files](#input_keep_extra_files) | boolean | false | `false` | Only update modified files. Default <br>false, to clean repo before <br>push. |
| <a name="input_openapi"></a>[openapi](#input_openapi) | string | false | | Include openapi output uploaded to <br>extra-docs-files artifact. |
| <a name="input_stories"></a>[stories](#input_stories) | string | false | | Include story build output uploaded <br>to extra-docs-files artifact. |

<!-- AUTO-DOC-INPUT:END -->

Expand Down

0 comments on commit b29f014

Please sign in to comment.