Closed stevepiercy closed 3 months ago
Regarding the XML issues, I'd instead just use:
.. code-block::
instead of:
.. code-block:: xml
these are only xml-snippets anyways. to make the rstchecker happy we would not only include the namespace definitions but also a proper xml root node i guess. and this would distract from the code block we wand to present here.
@thet thanks, done in 4485874. OK to merge?
@stevepiercy OK to merge!
rstcheck is used by GitHub to validate README.rst files. See https://github.com/orgs/community/discussions/86715#discussioncomment-8431598. Currently the README.rst does not pass this validation, thus making the README no longer render.
This PR addresses all the validation issues, except for the XML code-blocks. For that, I need some guidance from the maintainers. Semantically XML is the correct language, but HTML passes rstcheck. Should I change the language from XML to HTML?
This PR also updates a few outdated links and some minor syntax improvements.
This PR solves: