search

IBM / z_ansible_collections_doc

Repository for Z collections documentation
Apache License 2.0
8 stars 8 forks source link

Added support for showing requirements in the module docs #20

Closed andy-maier closed 3 years ago

andy-maier commented 3 years ago

This change updates the module.rst.j2 template file to add a section named "Requirements" after the "Synopsis" section, that shows the items in the "requirements" dictionary of the module documentation.

Example on how this is used in the ibm_zhmc collection:

Module DOCUMENTATION string:

requirements:
  - Access to the WS API of the HMC of the targeted Z system
    (see :term:`HMC API`).
  - The targeted Z system must be in the Dynamic Partition Manager (DPM)
    operational mode.

Resulting module docs page: See here

ddimatos commented 3 years ago

I tested it before accepting on one of your @andy-maier branches that had updated RST with requirements and it generated fine. When you are want the unified docs updated just ping me or @RadhaV2020 the branch to regenerate and publish. Right now your master branch has older doc without the requirements, it does not have to be the master branch , private one is fine just let us know.

image