internet/ansible-collections-openstack
3
0
Fork 0
mirror of https://opendev.org/openstack/ansible-collections-openstack.git synced 2026-04-12 11:51:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Properly documented openstacksdk version requirements

Browse Source 
With "extends_documentation_fragment: ['openstack.cloud.openstack']"
it is not necessary to list required Python libraries in section
'requirements' of DOCUMENTATION docstring in modules. Ansible will
merge requirements from doc fragments and DOCUMENTATION docstring
which previously resulted in duplicates such as in server module [0]:

* openstacksdk
* openstacksdk >= 0.36, < 0.99.0
* python >= 3.6

When removing the 'requirements' section from server module, then
Ansible will list openstacksdk once only:

* openstacksdk >= 0.36, < 0.99.0
* python >= 3.6

To see what documentation Ansible will produce for server module run:

  ansible-doc --type module openstack.cloud.server

[0] https://docs.ansible.com/ansible/latest/collections/openstack/\
    cloud/server_module.html

Change-Id: Ia53c2c34436c7a72080602f5699e82d20f677b8b
This commit is contained in:
Jakob Meng
2023-01-16 13:15:26 +01:00
parent bc16f70e1d
commit e4be201f20
84 changed files with 11 additions and 300 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/modules/stack.py
View File

@@ -51,10 +51,6 @@ options:
- Maximum number of seconds to wait for the stack creation
default: 3600
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''