From ae09c27ed7944a5c3ce84183769f66c5448a200e Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Mon, 13 Nov 2023 15:41:49 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=AA=20Test=20README=20builds=20in=20pr?= =?UTF-8?q?e-commit?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .pre-commit-config.yaml | 12 ++++++++++++ README.rst | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bc4e53e12..cbc338edd 100644 --- 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 index 7cc660b6b..a679df598 100644 --- 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