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

auto-doc: updated workflows docs
hotosm · Sep 28, 2023 · d8ed88f · d8ed88f
2 parents 08563a2 + 98ca631
commit d8ed88f
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/docs/doxygen_build.md b/docs/doxygen_build.md
@@ -4,10 +4,10 @@
 
 <!-- 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   |         |             |
-| <a name="input_output_dir"></a>[output_dir](#input_output_dir) | string |   true   |         |             |
+|                             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                                                                |
 
 <!-- AUTO-DOC-INPUT:END -->
 

diff --git a/docs/mkdocs_build.md b/docs/mkdocs_build.md
@@ -4,10 +4,10 @@
 
 <!-- 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   |         |             |
-| <a name="input_cache_path"></a>[cache_path](#input_cache_path) | string |  false   |         |             |
+|                             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.                                                      |
 
 <!-- AUTO-DOC-INPUT:END -->
 

diff --git a/docs/pypi_publish.md b/docs/pypi_publish.md
@@ -4,9 +4,9 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-|                             INPUT                              |  TYPE  | REQUIRED | DEFAULT | DESCRIPTION |
-|----------------------------------------------------------------|--------|----------|---------|-------------|
-| <a name="input_pypi_token"></a>[pypi_token](#input_pypi_token) | string |   true   |         |             |
+|                                        INPUT                                        |  TYPE  | REQUIRED | DEFAULT |                            DESCRIPTION                            |
+|-------------------------------------------------------------------------------------|--------|----------|---------|-------------------------------------------------------------------|
+| <a name="input_token_secret_name"></a>[token_secret_name](#input_token_secret_name) | string |   true   |         | The name of the repository <br>secret containing the PyPi token.  |
 
 <!-- AUTO-DOC-INPUT:END -->