diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b2aa5f747f4fcc57c4c8319f3906e9bff52efc01..2b7f782e56f0af0afb9e19f710a890ec4b098dac 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,8 +4,8 @@ on: - push - pull_request jobs: - check_docs: - name: Check Ansible Documentation. + check_docs_29: + name: Check Ansible Documentation with Ansible 2.9. runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 @@ -13,4 +13,20 @@ jobs: with: python-version: '3.x' - name: Run ansible-doc-test - run: ANSIBLE_LIBRARY="." python utils/ansible-doc-test roles plugins + run: | + python -m pip install "ansible < 2.10" + ANSIBLE_LIBRARY="." python utils/ansible-doc-test roles plugins + + check_docs_latest: + name: Check Ansible Documentation with latest Ansible. + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: '3.x' + - name: Run ansible-doc-test + run: | + python -m pip install ansible + ANSIBLE_LIBRARY="." python utils/ansible-doc-test roles plugins + diff --git a/roles/ipaclient/library/ipaclient_get_facts.py b/roles/ipaclient/library/ipaclient_get_facts.py index 003715efd3926c88437f99106daed5654150b976..b7e270fc3f0b66be9beecb6bd6955bfcd2bc8e96 100644 --- a/roles/ipaclient/library/ipaclient_get_facts.py +++ b/roles/ipaclient/library/ipaclient_get_facts.py @@ -1,6 +1,15 @@ #!/usr/bin/python # -*- coding: utf-8 -*- +DOCUMENTATION = """ +--- +module: ipaclient_get_facts +short description: Get facts about IPA client and server configuration. +description: Get facts about IPA client and server configuration. +author: + - Thomas Woerner +""" + import os import re import six diff --git a/roles/ipaclient/library/ipaclient_test.py b/roles/ipaclient/library/ipaclient_test.py index d5d7f7187941dff8e34ad8d7ba5298eaf478ad8a..1a80fafb6022b96aa585a7374e126abd56dd52bc 100644 --- a/roles/ipaclient/library/ipaclient_test.py +++ b/roles/ipaclient/library/ipaclient_test.py @@ -180,9 +180,9 @@ ntp_servers: type: list sample: ["ntp.example.com"] ipa_python_version: - description: - - The IPA python version as a number: - - <major version>*10000+<minor version>*100+<release> + description: > + The IPA python version as a number: + <major version>*10000+<minor version>*100+<release> returned: always type: int sample: 040400