A Python handler for mkdocstrings.
Project description
Python for mkdocstrings
A Python handler for mkdocstrings.
Requirements
Python for mkdocstrings requires Python 3.7 or above.
To install Python 3.7, 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.7
pyenv install 3.7.12
# make it available globally
pyenv global system 3.7.12
Installation
You can install this handler as a mkdocstrings extra:
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings[python]>=0.18",
]
You can also explicitely depend on the handler:
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings-python",
]
Project details
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-python-0.5.1.tar.gz
(18.5 kB
view hashes)
Built Distribution
Close
Hashes for mkdocstrings-python-0.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68105df91221120e96cfac685f267552f5e117c4babefa3db925f5c820213335 |
|
MD5 | 685295a2464ee234ee88c70801fa9145 |
|
BLAKE2b-256 | c249c134ec4119d647a640e378a7c172e48219962c5fbc4d314fe92832a1475d |
Close
Hashes for mkdocstrings_python-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57d0c14474c5f005367fa66f9954e672f7a7718ab892094174358280bc0a8e5c |
|
MD5 | e1a94997b5b596562e7b6dc7ff0e5ba8 |
|
BLAKE2b-256 | bfb05ae43dc86dcbea400aa0fbe4ff6ee61da6c5aa4efca660e6c31754011abb |