We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 5fccd06 commit 2c695cdCopy full SHA for 2c695cd
1 file changed
README.md
@@ -20,3 +20,17 @@ With [`pipx`](https://github.com/pipxproject/pipx):
20
python3.7 -m pip install --user pipx
21
pipx install griffe-typingdoc
22
```
23
+
24
+To use the extension in a MkDocs project,
25
+use this configuration:
26
27
+```yaml
28
+# mkdocs.yml
29
+plugins:
30
+- mkdocstrings:
31
+ handlers:
32
+ python:
33
+ options:
34
+ extensions:
35
+ - griffe_typingdoc
36
+```
0 commit comments