https://github.com/spirali/mkdocs-pdoc-plugin
https://github.com/spirali/mkdocs-pdoc-plugin
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/spirali/mkdocs-pdoc-plugin
- Owner: spirali
- License: mit
- Created: 2023-08-17T12:57:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-18T14:25:08.000Z (almost 3 years ago)
- Last Synced: 2025-01-13T06:28:34.587Z (over 1 year ago)
- Language: Python
- Size: 2.93 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-pdoc-plugin
This is a [MkDocs](https://www.mkdocs.org/) plugin for linking to API documentation generated by
[pdoc](https://pdoc.dev/) from `mkdocs`.
This plugin is inspired by https://github.com/Kobzol/mkdocs-nedoc-plugin
# Usage
1) Install `mkdocs-pdoc-plugin`
```commandline
$ python3 -m pip install git+https://github.com/spirali/mkdocs-pdoc-plugin
```
2) Generate documentation with `pdoc` into directory with mkdoc's markdown files.
```commandline
$ pdoc mypackage -o docs/
```
3) Configure plugin in `mkdocs.yaml`
```yaml
plugins:
- pdoc:
api_path:
```
`api_path` has to be a relative path where to find generated documentation in the documentation directory.
4) Link to code in `mkdocs` documentation. Link has to start with "pdoc:"
```
The [MyClass](pdoc:mypackage.MyClass) class is awesome.
The [do_something](pdoc:mypackage.MyClass.do_something) method is awesome.
```
You can omit title:
```
The [](mypackage.MyClass) class is awesome.
```
and the last part of the name will be used as the title (`MyClass` in this case)