mkdocstrings-python-generator is a mkdocs plugin for generating markdown pages automatically from python source code.
It is intended to fill a gap which is currently left to each user of mkdoctstings-python. Namely: generating markdown files for each python file.
Note despite the name there is no affiliation between mkdocstrings and mkdocstrings-python-generator. Please try to determine which plugin is to blame before posting issues here or there.
This project is in a very phase of development and not yet recomended for production.
To run unit tests ensure you have installed the project with all groups (default) or at least main,dev
.
Run tests with:
poetry run pytest
This project uses poetry and poetry-dynamic versioning.
You must either do a full git clone (default) not a shallow one, or you must otherwise ensure git can describe your checkout version in terms of tags:
git describe --tags
You use a PEP 517 build front-end like build
python3 -m pip install build
python3 -m build <project dir>
poetry self add poetry-dynamic-versioning
cd <project dir>
poetry build