Example
The extracted module documentation includes the documentation from the module header, and has invoked mkdocstrings to render api documentation based on Python docstrings.
Compare the webpage linked above with the raw module.md
generated
by extraction from module.py
:
## Python Version
You can put _markdown_ in triple-quoted strings in Python.
You can even combine it with mkdocstrings to automatically generate your source
documentation!
::: module.main
handler: python
options:
show_root_heading: true
show_source: false
heading_level: 3
Last update:
August 25, 2023