Lint rstfiles with rstcheck

ClearcodeHQ · Jul 28, 2023 · 52cc76e · 52cc76e
1 parent 6037fee
commit 52cc76e
Show file tree

Hide file tree

Showing 6 changed files with 120 additions and 2 deletions.
diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml
@@ -14,3 +14,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-elasticsearch
-==============
+==================================
 
 Thank you for taking time to contribute to pytest-elasticsearch!
 

diff --git a/Pipfile b/Pipfile
@@ -20,3 +20,4 @@ types-setuptools = "==68.0.0.3"
 mypy = "==1.4.1"
 types-mock = "==5.1.0.1"
 tbump = "==6.10.0"
+rstcheck = "==6.1.2"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/newsfragments/505.misc.rst b/newsfragments/505.misc.rst
@@ -0,0 +1 @@
+Lint rst files with rstcheck