Merge pull request #419 from ClearcodeHQ/rstcheck

Check Readme with rstcheck
ClearcodeHQ · Jul 20, 2023 · 097293b · 097293b
2 parents 6fe2712 + 7c50849
commit 097293b
Show file tree

Hide file tree

Showing 7 changed files with 323 additions and 3 deletions.
diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml
@@ -13,3 +13,4 @@ jobs:
       ruff: true
       black: true
       mypy: true
+      rstcheck: true
diff --git a/.rstcheck.cfg b/.rstcheck.cfg
@@ -0,0 +1,2 @@
+[rstcheck]
+report_level = warning
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1,5 +1,5 @@
 Contribute to pytest-mongo
-==============
+==========================
 
 Thank you for taking time to contribute to pytest-mongo!
 

diff --git a/Pipfile b/Pipfile
@@ -17,3 +17,4 @@ pytest-xdist = "==3.3.1"
 ruff = "==0.0.278"
 mypy = "==1.4.1"
 tbump = "==6.10.0"
+rstcheck = {version = "==6.1.2", extras = ["sphinx"]}
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.rst b/README.rst
@@ -138,7 +138,7 @@ Example usage:
 
 * use ``--mongo-port`` command line option when you run your tests
 
-    .. code-block::
+    .. code-block:: sh
 
         py.test tests --mongo-port=8888
 

diff --git a/newsfragments/419.misc.rst b/newsfragments/419.misc.rst
@@ -0,0 +1 @@
+Lint RST fields with rstcheck.