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.

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

Fix failing rstcheck #238

Merged
merged 2 commits into from
Feb 12, 2024
Merged

Fix failing rstcheck #238

merged 2 commits into from
Feb 12, 2024

Conversation

stevepiercy
Copy link
Member

@stevepiercy stevepiercy commented Feb 11, 2024

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?

$ bin/rstcheck imp.rst
imp.rst:347: (ERROR/3) (xml) unbound prefix: line 1, column 0
imp.rst:409: (ERROR/3) (xml) unbound prefix: line 1, column 0
imp.rst:1025: (ERROR/3) (xml) unbound prefix: line 1, column 0
Error! Issues detected.

This PR also updates a few outdated links and some minor syntax improvements.

This PR solves:

  1. Potentially address the GitHub rendering failure of README.rst.
  2. Subsequently allow the Plone Documentation builds to pass CI https://github.com/plone/documentation/actions/runs/7861502462/job/21449928462#step:5:1195

@stevepiercy stevepiercy self-assigned this Feb 11, 2024
@stevepiercy stevepiercy requested review from pbauer and thet February 11, 2024 11:11
Copy link
Member

@thet thet left a comment

Choose a reason for hiding this comment

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

LGTM

@thet
Copy link
Member

thet commented Feb 11, 2024

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.

@stevepiercy
Copy link
Member Author

@thet thanks, done in 4485874. OK to merge?

@thet
Copy link
Member

thet commented Feb 12, 2024

@stevepiercy OK‌ to merge!

@stevepiercy stevepiercy merged commit 2a7900f into main Feb 12, 2024
11 checks passed
@stevepiercy stevepiercy deleted the rstcheck branch February 12, 2024 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants