https://github.com/fel-thomas/numkdoc
Mkdoc autodoc from your numpy style docstrings
https://github.com/fel-thomas/numkdoc
mkdocs mkdocs-plugin numpydoc
Last synced: 3 months ago
JSON representation
Mkdoc autodoc from your numpy style docstrings
- Host: GitHub
- URL: https://github.com/fel-thomas/numkdoc
- Owner: fel-thomas
- License: mit
- Created: 2020-04-26T15:49:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-09T07:21:19.000Z (5 months ago)
- Last Synced: 2025-03-23T09:15:38.471Z (3 months ago)
- Topics: mkdocs, mkdocs-plugin, numpydoc
- Language: Python
- Homepage:
- Size: 23.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# NumKdoc
[](https://github.com/fel-thomas/numkdoc/actions/workflows/pypi.yml)
NumKdoc is a plugin for Mkdoc allowing you to automatically generate documentation from your Numpy style docstring, by making a simple call to classes.
This project is not maintained, and the parsing is not complete. It is based on the NumpyDoc parser.
## Quick start
If you want to try this plugin as-it-is, follow these steps:
1. Download this repo and (eventually) unzip it in a folder
2. Inside the project folder, execute the command
`python setup.py develop` to install
the plugin on your local machine.
3. Go to your mkdocs project folder, edit the `mkdocs.yml` file
and add these few lines at the end:
```yaml
plugins:
- numkdoc
```
That's it.
Now you can call the parsing of a class using the tag `{{ module.ClassName }}`,
Numkdoc will automatically substitue that tag with the class documentation.
### Example
For example, you could edit the `docs/api/core.md`
file and insert the tag in any place, like this:
```markdown
# Core Api
[...]
{{ src.module.Class }}
[...]
```