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.4.1

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.4.1.tar.gz (18.2 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.4.1-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocstrings-python-0.4.1.tar.gz
  • Upload date:
  • Size: 18.2 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.4.1.tar.gz
Algorithm Hash digest
SHA256 265e8731ffe10ac050111adbd2ee70d8da4cf79b2ee5dad55813a938bdf4dac3
MD5 193d3ec6c482a01ffad2a14f5c9ab216
BLAKE2b-256 897e49df52471f774ab20924088729173ca472f1e36b892e4035fa9c030b38e2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocstrings_python-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 34.2 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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c6c59b7bf13c99b56af00c1032363fca75f09fdc5ac34dedff05b2d8fdaaba0c
MD5 86077a0d52507c8e9c348484a67fdbd6
BLAKE2b-256 57065e9052562fc3ed2f1b554187fdc22d091107ccaf622db3a040a2fd8e566f

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