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

Jump to bottom

Fix broken HTML in return value RST tables #387

Merged
merged 2 commits into from
Jan 13, 2022
Merged

Fix broken HTML in return value RST tables #387

merged 2 commits into from
Jan 13, 2022

Conversation

felixfontein
Copy link
Collaborator

@felixfontein
Copy link
Collaborator Author

See the result at: https://ansible.fontein.de/collections/community/crypto/acme_certificate_module.html#return-values
Validator results: https://validator.w3.org/nu/?doc=https%3A%2F%2Fansible.fontein.de%2Fcollections%2Fcommunity%2Fcrypto%2Facme_certificate_module.html

(The validator applied to docs.ansible.com with this fix will have more warnings/errors, as some of them are about things introduced by the theme.)

@felixfontein felixfontein mentioned this pull request Jan 13, 2022
Open
@samccann
Copy link
Contributor

Verified this fixes the reported error when using lynx. Should we open a ticket on the theme to cover the other warnings?

samccann
samccann approved these changes Jan 13, 2022
View reviewed changes
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't comment on the code but I verified the html error doesn't show up now.

@dmsimard
Copy link
Contributor

Thanks @felixfontein !

@dmsimard dmsimard merged commit 5dc65f8 into ansible-community:main Jan 13, 2022
@felixfontein felixfontein deleted the fix-html branch January 13, 2022 21:45
@felixfontein
Copy link
Collaborator Author

@dmsimard thanks for reviewing and merging!

@felixfontein
Copy link
Collaborator Author

Ah, sorry, @samccann didn't see you also reviewed/tested. Thanks for that!

About the theme: it might be useful to re-build the real docs with this fix and check out what the validator still reports afterwards. Broken HTML can confuse the validator and result in more warnings/errors than necessary.

@felixfontein felixfontein mentioned this pull request Jan 14, 2022
Merged
felixfontein added a commit to felixfontein/antsibull-build that referenced this pull request Jan 14, 2022
@felixfontein
Revert "Fix broken HTML in return value RST tables (ansible-community…
22a26f4 
…#387)"

(So we can see whether this test fails.)

This reverts commit 5dc65f8.
@felixfontein felixfontein mentioned this pull request Jan 14, 2022
Merged
felixfontein added a commit to felixfontein/antsibull-build that referenced this pull request Jan 26, 2022
@felixfontein
Revert "Fix broken HTML in return value RST tables (ansible-community…
1314e73 
…#387)"

(So we can see whether this test fails.)

This reverts commit 5dc65f8.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samccann samccann samccann approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@felixfontein @samccann @dmsimard