mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
fd2528dc3c
Do extra docs validation; explicitly disallow semantic markup in docs (#6345) * Do extra docs validation. Explicitly disallow semantic markup in docs. * Forgot to add new requirement. * Fix prefixes. * Remove superfluous condition. * TEMP - make CI fail. * Revert "TEMP - make CI fail." This reverts commit14f4d6b503. * Remove unnecessary import. * Make sure ANSIBLE_COLLECTIONS_PATH is set. * Make sure sanity tests from older Ansible versions don't complain. (cherry picked from commitee11847c7e) Co-authored-by: Felix Fontein <felix@fontein.de>
29 lines
1.1 KiB
Python
Executable file
29 lines
1.1 KiB
Python
Executable file
#!/usr/bin/env python
|
|
# Copyright (c) Ansible Project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
"""Check extra collection docs with antsibull-docs."""
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
import sys
|
|
import subprocess
|
|
|
|
|
|
def main():
|
|
"""Main entry point."""
|
|
env = os.environ.copy()
|
|
suffix = ':{env}'.format(env=env["ANSIBLE_COLLECTIONS_PATH"]) if 'ANSIBLE_COLLECTIONS_PATH' in env else ''
|
|
env['ANSIBLE_COLLECTIONS_PATH'] = '{root}{suffix}'.format(root=os.path.dirname(os.path.dirname(os.path.dirname(os.getcwd()))), suffix=suffix)
|
|
p = subprocess.run(
|
|
['antsibull-docs', 'lint-collection-docs', '--plugin-docs', '--disallow-semantic-markup', '--skip-rstcheck', '.'],
|
|
env=env,
|
|
check=False,
|
|
)
|
|
if p.returncode not in (0, 3):
|
|
print('{0}:0:0: unexpected return code {1}'.format(sys.argv[0], p.returncode))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|