Add checks for reST content (#273)

* Add pre-commit check of RST content * Ignore unsupported sphinx directives in rstcheck config file rstcheck doesn't have awareness of sphinx-specific directives or extensions. * Fix rstcheck errors * Redundant reference "contributing" matches the title of the document. * Change duplicate references named "yarn" to anonymous references. * Fix code block by adding blank line after directive line. * Move rstcheck config into pre-commit config --------- Co-authored-by: Nicolas Brichet <[email protected]>
geojupyter · Jan 3, 2025 · fab1a41 · fab1a41
1 parent 90abbb8
commit fab1a41
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -32,3 +32,9 @@ repos:
       - id: ruff
         args: ['--fix']
       - id: ruff-format
+
+  - repo: https://github.com/rstcheck/rstcheck
+    rev: v6.2.4
+    hooks:
+      - id: rstcheck
+        args: ['--ignore-directives=tabs,toctree,autoclass', '--report-level=warning']
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -1,5 +1,3 @@
-.. _contributing:
-
 ============
 Contributing
 ============
@@ -12,8 +10,8 @@ Development install
     You will need `Node.js <https://nodejs.org/>`_ to build the extension package.
 
     The ``jlpm`` command is JupyterLab's pinned version of
-    `yarn <https://yarnpkg.com/>`_ that is installed with JupyterLab. You may use
-    `yarn <https://yarnpkg.com/>`_ or `npm <https://www.npmjs.com/>`_ in lieu of ``jlpm`` below.
+    `yarn <https://yarnpkg.com/>`__ that is installed with JupyterLab. You may use
+    `yarn <https://yarnpkg.com/>`__ or `npm <https://www.npmjs.com/>`_ in lieu of ``jlpm`` below.
 
 
 Clone the source
@@ -65,6 +63,7 @@ Install dependencies and build
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: bash
+
     # Install JupyterLab for jlpm
     python -m pip install jupyterlab