Autogenerate documentation for checks (#230)

dosisod · Mar 11, 2023 · dd7e2d2 · dd7e2d2
1 parent f0fcf2d
commit dd7e2d2
Show file tree

Hide file tree

Showing 5 changed files with 1,716 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -53,3 +53,7 @@ jobs:
 
       - name: Run e2e tests
         run: make test-e2e
+
+        # TODO: fail if docs are out of date
+      - name: Build docs
+        run: make docs
diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
-.PHONY: install ruff mypy black isort test test-e2e refurb
+.PHONY: install ruff mypy black isort test test-e2e refurb docs
 
-all: ruff mypy black isort test refurb
+all: ruff mypy black isort test refurb docs
 
 install:
 	pip install .
@@ -35,3 +35,6 @@ test/%.txt: test/%.py
 	refurb "$^" --enable-all --quiet > "$@" || true
 
 update-tests: $(patsubst %.py,%.txt,$(wildcard test/data*/*.py))
+
+docs:
+	python3 -m docs.gen_checks
diff --git a/README.md b/README.md
@@ -70,6 +70,8 @@ num = 123
 ```
 ````
 
+An online list of all available checks can be viewed [here](./docs/checks.md).
+
 ## Ignoring Errors
 
 Use `--ignore 123` to ignore error 123. The error code can be in the form `FURB123` or `123`.
-Original file line number
+Diff line change
@@ Expand Up / @@ -70,6 +70,8 @@ num = 123 @@
     ```
     ````
+    An online list of all available checks can be viewed [here](./docs/checks.md).
     ## Ignoring Errors
     Use `--ignore 123` to ignore error 123. The error code can be in the form `FURB123` or `123`.
@@ Expand Down @@