Skip to content

mkdocstrings/python

Repository files navigation

Python for mkdocstrings

ci documentation pypi version gitter

A Python handler for mkdocstrings.

Requirements

Python for 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.12

# make it available globally
pyenv global system 3.6.12

Installation

With pip:

python3.6 -m pip install mkdocstrings-python

With pipx:

python3.6 -m pip install --user pipx

pipx install --python python3.6 mkdocstrings-python