Skip to main content

A Python handler for mkdocstrings.

Project description

Python for mkdocstrings

ci documentation pypi version gitpod gitter

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

With pip:

pip install mkdocstrings-python

With pipx:

python3.7 -m pip install --user pipx
pipx install mkdocstrings-python

Project details


Release history Release notifications | RSS feed

This version

0.5.0

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.0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocstrings_python-0.5.0-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file mkdocstrings-python-0.5.0.tar.gz.

File metadata

  • Download URL: mkdocstrings-python-0.5.0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.10.0 pkginfo/1.8.1 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for mkdocstrings-python-0.5.0.tar.gz
Algorithm Hash digest
SHA256 2c06c176ad40e2a217f2a780b42f39ac34bf6ddf853869ae2bd17a11f63ae8f3
MD5 d01ed5605228f140be7f6ca3465b8e7e
BLAKE2b-256 70e6f451eb68798cb6beecef22558ee267fcaefd14a9821f78661264c728ef6d

See more details on using hashes here.

File details

Details for the file mkdocstrings_python-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: mkdocstrings_python-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.10.0 pkginfo/1.8.1 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for mkdocstrings_python-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b77450a52275028dfe5f2169fa0b03701f1495982a7a09647afa943120776600
MD5 96d7a1f45085903f4acffb9ed0296b05
BLAKE2b-256 7d680fdac938c3d7e5cddf84eb7e2d9f496bee537141cd6471ce2b172eb60e26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page