docs: add mkdocstrings for api reference

heitorlessa · heitorlessa · commit 59beea6f9d72 · 2021-07-09T21:15:59.000+02:00
Signed-off-by: heitorlessa &lt;lessa@amazon.co.uk&gt;
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1 @@
+::: aws_lambda_powertools.tracing.Tracer
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,7 +8,7 @@ nav:
   - Homepage: index.md
   - Changelog: changelog.md
   - Roadmap: https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1" target="_blank
-  - API reference: api/" target="_blank
+  - API reference: api.md
   - Core utilities:
       - core/tracer.md
       - core/logger.md
@@ -26,6 +26,7 @@ nav:
       - utilities/parser.md
       - utilities/idempotency.md
 
+
 theme:
   name: material
   palette:
@@ -73,6 +74,9 @@ copyright: Copyright &copy; 2021 Amazon Web Services
 plugins:
   - git-revision-date
   - search
+  - mkdocstrings:
+      watch:
+        - aws_lambda_powertools
 
 extra_css:
   - stylesheets/extra.css
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -52,6 +52,7 @@ flake8-bugbear = "^21.3.2"
 mkdocs-material = "^7.1.9"
 mkdocs-git-revision-date-plugin = "^0.3.1"
 mike = "^0.6.0"
+mkdocstrings = "^0.15.2"
 
 
 [tool.poetry.extras]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+::: aws_lambda_powertools.tracing.Tracer`