feat: use undocumented numpy support in mkdocstrings

heitorlessa · Jul 17, 2021 · 07e1ed4 · 07e1ed4
1 parent 0bd4142
commit 07e1ed4
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -75,6 +75,10 @@ plugins:
  - git-revision-date
  - search
  - mkdocstrings:
+ handlers:
+ python:
+ selection:
+ docstring_style: numpy
  watch:
  - aws_lambda_powertools
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -53,6 +53,7 @@ mkdocs-material = "^7.1.9"
 mkdocs-git-revision-date-plugin = "^0.3.1"
 mike = "^0.6.0"
 mkdocstrings = "^0.15.2"
+pytkdocs = {extras = ["numpy-style"], version = "^0.11.1"}
 
 
 [tool.poetry.extras]