chore: Auto generate docs

nvimtools · Jan 17, 2025 · af31821 · af31821
1 parent b93e44d
commit af31821
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 19 deletions.
diff --git a/doc/BUILTINS.md b/doc/BUILTINS.md
@@ -1010,23 +1010,6 @@ local sources = { null_ls.builtins.diagnostics.mypy }
 - Command: `mypy`
 - Args: dynamically resolved (see [source](https://github.com/nvimtools/none-ls.nvim/blob/main/lua/null-ls/builtins/diagnostics/mypy.lua))
 
-### [pydoclint](https://jsh9.github.io/pydoclint/)
-
-Pydoclint is a Python docstring linter to check whether a docstring's sections (arguments, returns, raises, ...) match the function signature or function implementation.
-Usage
-
-```lua
-local sources = { null_ls.builtins.diagnostics.pydoclint }
-```
-
-#### Defaults
-
-- Filetypes: `{ "python" }`
-- Method: `diagnostics`
-- Command: `pydoclint`
-- Args: dynamically resolved (see source)
-
-
 ### [npm_groovy_lint](https://github.com/nvuillam/npm-groovy-lint)
 
 Lint, format and auto-fix Groovy, Jenkinsfile, and Gradle files.
@@ -1221,6 +1204,23 @@ local sources = { null_ls.builtins.diagnostics.puppet_lint }
 - Command: `puppet-lint`
 - Args: `{ "--json", "$FILENAME" }`
 
+### [pydoclint](https://github.com/jsh9/pydoclint)
+
+Pydoclint is a Python docstring linter to check whether a docstring's sections (arguments, returns, raises, ...) match the function signature or function implementation. To see all violation codes go to [pydoclint](https://jsh9.github.io/pydoclint/violation_codes.html)
+
+#### Usage
+
+```lua
+local sources = { null_ls.builtins.diagnostics.pydoclint }
+```
+
+#### Defaults
+
+- Filetypes: `{ "python" }`
+- Method: `diagnostics`
+- Command: `pydoclint`
+- Args: `{ "--show-filenames-in-every-violation-message=true", "-q", "$FILENAME" }`
+
 ### [pylint](https://github.com/PyCQA/pylint)
 
 Pylint is a Python static code analysis tool which looks for programming

diff --git a/doc/builtins.json b/doc/builtins.json
@@ -325,6 +325,11 @@
         "epuppet"
       ]
     },
+    "pydoclint": {
+      "filetypes": [
+        "python"
+      ]
+    },
     "pylint": {
       "filetypes": [
         "python"

diff --git a/doc/null-ls.txt b/doc/null-ls.txt
@@ -1,4 +1,4 @@
-*null-ls.txt*                                     Last change: 2025 January 15
+*null-ls.txt*                                     Last change: 2025 January 17
 
 ==============================================================================
 Table of Contents                                  *null-ls-table-of-contents*

diff --git a/lua/null-ls/builtins/_meta/diagnostics.lua b/lua/null-ls/builtins/_meta/diagnostics.lua
@@ -148,6 +148,9 @@ return {
   puppet_lint = {
     filetypes = { "puppet", "epuppet" }
   },
+  pydoclint = {
+    filetypes = { "python" }
+  },
   pylint = {
     filetypes = { "python" }
   },

diff --git a/lua/null-ls/builtins/_meta/filetype_map.lua b/lua/null-ls/builtins/_meta/filetype_map.lua
@@ -340,7 +340,7 @@ return {
   },
   python = {
     code_actions = { "refactoring" },
-    diagnostics = { "mypy", "pylint", "semgrep" },
+    diagnostics = { "mypy", "pydoclint", "pylint", "semgrep" },
     formatting = { "black", "blackd", "isort", "isortd", "pyink", "usort", "yapf" }
   },
   qml = {