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

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.1.0.tar.gz (15.8 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.1.0-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocstrings-python-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2d086ab4eb44bbbd4d06c6987572d361da934332e8bec2eca5f3d59ff18127bc
MD5 ce90f4177fe3c3282679766b8d8928a4
BLAKE2b-256 6c0bac261080750c4fa3ca1a144462ae235607adda8416431fe9d139a3932572

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mkdocstrings_python-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 743da5918c4ed032e5436e38825982f348b74f475e845844cff9531d95f374e3
MD5 7f1b3f5894a967f8a209ea25bf6e6a0c
BLAKE2b-256 92f10938bb5c881aa39e1bb237137bf8190714af7697ebc5894327b3a70766eb

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