🧪 Test README builds in pre-commit (#1069)

useblocks · Nov 13, 2023 · 83d0934 · 83d0934
1 parent 4c83692
commit 83d0934
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -42,3 +42,15 @@ repos:
     rev: 1.7.0
     hooks:
       - id: poetry-check
+
+  - repo: local
+    hooks:
+      - id: check-readme
+        name: check-readme
+        files: README.rst
+        language: python
+        entry: rst2html.py README.rst --halt=warning
+        pass_filenames: false
+        additional_dependencies:
+        - docutils==0.20.1
+        - pygments
diff --git a/README.rst b/README.rst
@@ -61,7 +61,7 @@ Using pip
 
     pip install sphinx-needs
 
-If you wish to also use the plotting features of sphinx-needs (see :ref:`needbar` and :ref:`needpie`), you need to also install ``matplotlib``, which is available *via* the ``plotting`` extra:
+If you wish to also use the plotting features of sphinx-needs (see ``needbar`` and ``needpie``), you need to also install ``matplotlib``, which is available *via* the ``plotting`` extra:
 
 .. code-block:: bash