docs: lint rst files (#1581)

2023-08-31 15:49:01 -04:00
parent 932748916b
commit a3eec98ae1
21 changed files with 81 additions and 48 deletions
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -12,7 +12,12 @@ build:
  tools:
    python: "3.11"
  apt_packages:
-    - graphviz
+    - graphviz  # required to build diagrams
+    - libboost-locale-dev  # required for rstcheck in cpp code block
+  jobs:
+    post_build:
+      - rstcheck -r .  # lint rst files
+      # - rstfmt --check --diff -w 120 .  # check rst formatting

 # submodules required for include statements
 submodules: