Closed justinc1 closed 1 year ago
Before we generated docs for modules with ansible-docs-extractor. Now we have also roles to include into documentation. antsibull-docs is able to also generate role documentation from role arguments_specs.yml. PR does switch to antsibull-docs.
arguments_specs.yml
In addition, a quickstart guide in included. The file was added to https://github.com/ScaleComputing/HyperCoreAnsibleCollection-docs/blob/gh-pages/docs/_sources/modules/quickstart.rst.txt (rendered html at https://scalecomputing.github.io/HyperCoreAnsibleCollection-docs/modules/quickstart.html). The -docs repo was intended to contain only rendered html documentation (we should replace all content in -docs repo on each release). I guess this is still valid. You agree @jtaubenheim?
Modules RETURN sections should be adjusted to get a nicer output. Will be done in separate PR, here it is done for cluster_info only.
cluster_info
Before we generated docs for modules with ansible-docs-extractor. Now we have also roles to include into documentation. antsibull-docs is able to also generate role documentation from role
arguments_specs.yml. PR does switch to antsibull-docs.In addition, a quickstart guide in included. The file was added to https://github.com/ScaleComputing/HyperCoreAnsibleCollection-docs/blob/gh-pages/docs/_sources/modules/quickstart.rst.txt (rendered html at https://scalecomputing.github.io/HyperCoreAnsibleCollection-docs/modules/quickstart.html). The -docs repo was intended to contain only rendered html documentation (we should replace all content in -docs repo on each release). I guess this is still valid. You agree @jtaubenheim?
Modules RETURN sections should be adjusted to get a nicer output. Will be done in separate PR, here it is done for
cluster_infoonly.