Merge pull request #5 from hotosm/docs/auto-doc-update-workflows

auto-doc: updated workflows docs
hotosm · Sep 28, 2023 · 3c82ea0 · 3c82ea0
2 parents efd5d40 + 4e1dc82
commit 3c82ea0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 16 deletions.
diff --git a/docs/doxygen_build.md b/docs/doxygen_build.md
@@ -4,27 +4,23 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-| INPUT                                                          | TYPE   | REQUIRED | DEFAULT | DESCRIPTION                                                                                                                                                             |
-| -------------------------------------------------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a name="input_cache_key"></a>[cache_key](#input_cache_key)    | string | false    |         | The cache key to pass <br>to mkdocs_build, e.g.: echo "cache_key=docs-build-$(date --utc '+%V')" <br>>> $GITHUB_ENV Then use, with: <br>cache_key: ${{ env.cache_key }} |
-| <a name="input_output_dir"></a>[output_dir](#input_output_dir) | string | true     |         | Output directory for Doxygen to <br>compile                                                                                                                             |
+|                             INPUT                              |  TYPE  | REQUIRED | DEFAULT |                    DESCRIPTION                    |
+|----------------------------------------------------------------|--------|----------|---------|---------------------------------------------------|
+|  <a name="input_cache_key"></a>[cache_key](#input_cache_key)   | string |  false   |         | The cache key to receive <br>from a previous job  |
+| <a name="input_output_dir"></a>[output_dir](#input_output_dir) | string |   true   |         |   Output directory for Doxygen to <br>compile     |
 
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
-
 No secrets.
-
 <!-- AUTO-DOC-SECRETS:END -->
 
 ## Example Usage

diff --git a/docs/mkdocs_build.md b/docs/mkdocs_build.md
@@ -4,27 +4,23 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-| INPUT                                                          | TYPE   | REQUIRED | DEFAULT | DESCRIPTION                                                                                                                                                                        |
-| -------------------------------------------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a name="input_cache_key"></a>[cache_key](#input_cache_key)    | string | false    |         | The cache key to receive <br>from a previous job, e.g.: <br>echo "cache_key=docs-build-$(date --utc '+%V')" >> $GITHUB_ENV Then <br>use, with: cache_key: ${{ env.cache_key <br>}} |
-| <a name="input_cache_path"></a>[cache_path](#input_cache_path) | string | false    |         | The path from a previously <br>cached job, e.g. `apidocs` from <br>Doxygen.                                                                                                        |
+|                             INPUT                              |  TYPE  | REQUIRED | DEFAULT |                                 DESCRIPTION                                  |
+|----------------------------------------------------------------|--------|----------|---------|------------------------------------------------------------------------------|
+|  <a name="input_cache_key"></a>[cache_key](#input_cache_key)   | string |  false   |         |              The cache key to receive <br>from a previous job                |
+| <a name="input_cache_path"></a>[cache_path](#input_cache_path) | string |  false   |         | The path from a previously <br>cached job, e.g. `apidocs` from <br>Doxygen.  |
 
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
-
 No secrets.
-
 <!-- AUTO-DOC-SECRETS:END -->
 
 ## Example Usage