Skip to content

Commit

Permalink
Merge pull request #1161 from Bastian-Krause/bst/readme-rst-warnings
Browse files Browse the repository at this point in the history
README: fix RST syntax and introduce check
  • Loading branch information
Emantor committed May 2, 2023
2 parents 6356f42 + 87a3ed4 commit 6977ba3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .github/workflows/reusable-unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,7 @@ jobs:
make -C man clean
make -C man all
git --no-pager diff --exit-code
# check README.rst separately
pip install rstcheck
rstcheck --ignore-languages=bash --report-level=WARNING README.rst
- uses: codecov/codecov-action@v3
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ automated testing, several planned features are not yet implemented and the APIs
may be changed as more use-cases appear.
We appreciate code contributions and feedback on using labgrid on other
environments (see `Contributing
<https://labgrid.readthedocs.io/en/latest/development.html#contributing>`_ for
<https://labgrid.readthedocs.io/en/latest/development.html#contributing>`__ for
details).
Please consider contacting us (via a GitHub issue) before starting larger
changes, so we can discuss design trade-offs early and avoid redundant work.
Expand Down

0 comments on commit 6977ba3

Please sign in to comment.