Automatic documentation from docstrings, for mkdocs.
Project description
mkdocstrings
Automatic documentation from docstrings, for mkdocs.
This plugin is still in alpha status. Here is how it looks with the mkdocs-material theme for now:
Requirements
mkdocstrings requires Python 3.6 or above.
To install Python 3.6, I recommend using pyenv.
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv
# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"
# install Python 3.6
pyenv install 3.6.8
# make it available globally
pyenv global system 3.6.8
Installation
With pip:
python3.6 -m pip install mkdocstrings
With pipx:
python3.6 -m pip install --user pipx
pipx install --python python3.6 mkdocstrings
Usage
# mkdocs.yml
plugins:
- mkdocstrings
# Reference
::: my_library.my_module.my_class
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocstrings-0.2.0.tar.gz
(9.8 kB
view details)
Built Distribution
File details
Details for the file mkdocstrings-0.2.0.tar.gz.
File metadata
- Download URL: mkdocstrings-0.2.0.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.0 CPython/3.6.9 Linux/5.4.2-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8027b82a04d5bacc561c34e9cc96568d7b7936bea970f38c3fcdc1ff6266e92f |
|
| MD5 | 510a9e83025d50c1c86d58cf0d71b0da |
|
| BLAKE2b-256 | cfe5e48721da64f9257f64372ca94ed9e0ea858e64e6c7940f0949403c542fb8 |
File details
Details for the file mkdocstrings-0.2.0-py3-none-any.whl.
File metadata
- Download URL: mkdocstrings-0.2.0-py3-none-any.whl
- Upload date:
- Size: 11.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.0 CPython/3.6.9 Linux/5.4.2-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 90e4917c109939cd40e34222d27d73c10417e070e0be88e19374aec7ccbeb46a |
|
| MD5 | 0aa529d21b9b3c7be9056f3a13a5075c |
|
| BLAKE2b-256 | 8743eaad96e065bdc926da9663514f3d982b5d24f5160bc02fdad867a9cd34b6 |
