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.2.tar.gz
(18.5 kB
view hashes)
Built Distribution
Close
Hashes for mkdocstrings-python-0.5.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 782b6ea41f86cfcc7d8d4a05cecc865fa21dfb5367f1457d7d3e448517958609 |
|
MD5 | 9c424450dde032bf5e42cf5f4f52aaaf |
|
BLAKE2b-256 | 414b33a93e0a3f99eb1572b8b96dbcca60c38136baf3038829746cdc2282a264 |
Close
Hashes for mkdocstrings_python-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80aeaa9a774c87ead3c71b4e8aca0b940efcb6a623e4c7f51e3b0d2e537f1f2b |
|
MD5 | 80d938136db6f41e97489b4d768b05ac |
|
BLAKE2b-256 | 60ce74c5fc893c8df67e396b717a6128e41366a63a50afa16ebf0535c4feb389 |