Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do extra docs validation; explicitly disallow semantic markup in docs #165

Merged
merged 8 commits into from
Apr 16, 2023
Merged

Do extra docs validation; explicitly disallow semantic markup in docs #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1464e0d
Do extra docs validation. Explicitly disallow semantic markup in docs.
felixfontein Apr 16, 2023
53f2ea5
Forgot to add new requirement.
felixfontein Apr 16, 2023
127ada0
Improve test.
felixfontein Apr 16, 2023
54baa31
TEMP - make CI fail.
felixfontein Apr 16, 2023
dd2cd20
Remove unnecessary import.
felixfontein Apr 16, 2023
043610d
Make sure ANSIBLE_COLLECTIONS_PATH is set.
felixfontein Apr 16, 2023
02164b1
Revert "TEMP - make CI fail."
felixfontein Apr 16, 2023
5ba19d2
Make sure sanity tests from older Ansible versions don't complain.
felixfontein Apr 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion tests/sanity/extra/extra-docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
{
"include_symlinks": false,
"prefixes": [
"docs/docsite/"
"docs/docsite/",
"plugins/",
"roles/"
],
"output": "path-line-column-message",
"requirements": [
"ansible-core",
"antsibull-docs"
]
}
11 changes: 8 additions & 3 deletions tests/sanity/extra/extra-docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,14 @@

def main():
"""Main entry point."""
if not os.path.isdir(os.path.join('docs', 'docsite')):
return
p = subprocess.run(['antsibull-docs', 'lint-collection-docs', '.'], check=False)
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))

Expand Down