chore: generate API docs for flake8

Part 3 of the 'adding a linter' guide
aspect-build · Oct 12, 2023 · 949c47e · 949c47e
1 parent 3efc2fe
commit 949c47e
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -38,6 +38,8 @@ We have a separate project for formatting, see <https://github.com/aspect-build/
   - `buf lint`: <https://buf.build/docs/lint/overview>
 - JavaScript
   - `eslint`: https://eslint.org/
+- Python
+  - `flake8`: <https://flake8.pycqa.org/en/latest/index.html>
 
 ### Adding a linter
 

diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel
@@ -12,4 +12,9 @@ stardoc_with_diff_test(
     bzl_library_target = "//lint:eslint",
 )
 
+stardoc_with_diff_test(
+    name = "flake8",
+    bzl_library_target = "//lint:flake8",
+)
+
 update_docs(name = "update")
diff --git a/docs/flake8.md b/docs/flake8.md
diff --git a/lint/BUILD.bazel b/lint/BUILD.bazel
@@ -18,3 +18,9 @@ bzl_library(
         "@aspect_rules_js//js:libs",
     ],
 )
+
+bzl_library(
+    name = "flake8",
+    srcs = ["flake8.bzl"],
+    visibility = ["//visibility:public"],
+)
diff --git a/lint/README.md b/lint/README.md
@@ -69,7 +69,6 @@ https://github.com/aspect-build/rules_lint/commit/29d275bcf7ecf5b99c6bff6913322f
 
 Add a rule in the `docs/` folder matching the existing ones, so that the API docs are auto-generated.
 Run `bazel run docs:update` to create the Markdown file.
-
 Also add your new linter to the README.
 
 Here's a commit showing what it should look like: