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

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.3.0.tar.gz (17.9 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.3.0-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocstrings-python-0.3.0.tar.gz
  • Upload date:
  • Size: 17.9 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.3.0.tar.gz
Algorithm Hash digest
SHA256 87e124c5a8e4d8ebbae6f984a12d87bcd49c67de8fd63e98c1d3a6a39e1d43aa
MD5 7c7af0d45244737a8d5363c37966ac4b
BLAKE2b-256 dd89a44f84c21be8aaea65fae5b97d8998e7a7a0bc312bef8443276fd81d0d29

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocstrings_python-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 32.6 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 674552a3848db1fbd788ec7e595b76b79354b3aa8715404614f4ad7ccd2178ce
MD5 38b0adab3ace2b91d86e6d7dd0df6691
BLAKE2b-256 85739745e263b26653317374cffde57201da412a8c3371754482215aff9561eb

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