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.1.0.tar.gz
(8.7 kB
view details)
Built Distribution
File details
Details for the file mkdocstrings-0.1.0.tar.gz.
File metadata
- Download URL: mkdocstrings-0.1.0.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/0.12.17 CPython/3.6.9 Linux/5.4.2-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5c7aaf2ad9e6ea60824ff733cceaa1c6a8426ea0bddd8a1df8bf79ff37548a14 |
|
| MD5 | bdf0a0515fdd9df15c459752ef5a1198 |
|
| BLAKE2b-256 | 455e5fa26ed27ec0c662952bd92ccecb5e1bd846128985e4d2bbc44d4c036a5a |
Provenance
File details
Details for the file mkdocstrings-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mkdocstrings-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/0.12.17 CPython/3.6.9 Linux/5.4.2-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 92196a319a325f8e3c5917c8d404ca8c7ac11a8965621eec4d26876c1d6928f0 |
|
| MD5 | 1ecfe852d6f7c6b1bfacf7ac446b3c3c |
|
| BLAKE2b-256 | e8a8528e0bfcb7da3d8f793d18fdbc053b806818bd50d45f230106f93016a8e5 |
