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

Add rstcheck #106

Merged
merged 2 commits into from
Nov 20, 2023
Merged

Add rstcheck #106

merged 2 commits into from
Nov 20, 2023

Conversation

Alrobbertz
Copy link
Member

@Alrobbertz Alrobbertz commented Nov 15, 2023

This PR adds a package rstcheck which validates syntax and formatting of .rst based Sphinx documentation. The advantage of adding this package is that it can report simple errors in docs formatting without needing to build the documentation, either locally or in the pipeline. The rstcheck tool is added both as a pre-commit hook as well as a pipeline step in the docs pipeline.

To run the rstcheck tool locally you can use the following command from the root of the hermes_core repository.

rstcheck -r docs

closes #96

Copy link

codecov bot commented Nov 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a7315cb) 94.28% compared to head (ea0e9bf) 94.28%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   94.28%   94.28%           
=======================================
  Files          10       10           
  Lines        1767     1767           
=======================================
  Hits         1666     1666           
  Misses        101      101           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Alrobbertz Alrobbertz marked this pull request as ready for review November 15, 2023 21:05
Copy link
Member

@ehsteve ehsteve left a comment

Choose a reason for hiding this comment

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

I did not know that this existed. Looks good!

@Alrobbertz Alrobbertz merged commit 5a713b6 into HERMES-SOC:main Nov 20, 2023
14 checks passed
@Alrobbertz Alrobbertz deleted the 96-docs-checking branch January 2, 2024 17:02
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.

Look into automated docs formatting
2 participants