Support in module template for hiding private input parms

Details: * This change modifies the module.rst.j2 template to skip input parameters if their name starts with '_'. Signed-off-by: Andreas Maier <maiera@de.ibm.com>
zhmcclient · Nov 27, 2020 · de0560b · de0560b
1 parent 275eb48
commit de0560b
Show file tree

Hide file tree

Showing 12 changed files with 1 addition and 78 deletions.
diff --git a/docs/source/modules/zhmc_adapter.rst b/docs/source/modules/zhmc_adapter.rst
@@ -126,13 +126,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_cpc.rst b/docs/source/modules/zhmc_cpc.rst
@@ -93,13 +93,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_crypto_attachment.rst b/docs/source/modules/zhmc_crypto_attachment.rst
@@ -135,13 +135,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_hba.rst b/docs/source/modules/zhmc_hba.rst
@@ -115,13 +115,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_nic.rst b/docs/source/modules/zhmc_nic.rst
@@ -115,13 +115,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_partition.rst b/docs/source/modules/zhmc_partition.rst
@@ -133,13 +133,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_storage_group.rst b/docs/source/modules/zhmc_storage_group.rst
@@ -113,13 +113,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_storage_group_attachment.rst b/docs/source/modules/zhmc_storage_group_attachment.rst
@@ -98,13 +98,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_storage_volume.rst b/docs/source/modules/zhmc_storage_volume.rst
@@ -111,13 +111,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_user.rst b/docs/source/modules/zhmc_user.rst
@@ -114,13 +114,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/source/modules/zhmc_virtual_function.rst b/docs/source/modules/zhmc_virtual_function.rst
@@ -113,13 +113,6 @@ log_file
   | **type**: str
 
 
-_faked_session
-  An internal parameter used for testing the module.
-
-  | **required**: False
-  | **type**: raw
-
-
 
 
 Examples

diff --git a/docs/templates/module.rst.j2 b/docs/templates/module.rst.j2
@@ -50,7 +50,7 @@ Synopsis
 {% macro option_generation(opts, level) %}
 {# Control the order of options: true: ordered by name; false: keep source order #}
 {%   set sorted = false %}
-{%   for name, spec in (opts | dictsort if sorted else opts.items()) %}
+{%   for name, spec in (opts | dictsort if sorted else opts.items()) if not name.startswith('_') %}
 
 {{ "  " * level }}{{ name }}
 {%     for para in spec.description %}