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.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.4.0.tar.gz (18.1 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.0-py3-none-any.whl (34.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocstrings-python-0.4.0.tar.gz
  • Upload date:
  • Size: 18.1 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.0.tar.gz
Algorithm Hash digest
SHA256 cd2aa0aed13376c7ed4e8f5de072da7c4ed253b06da54af27c2630fc0190687a
MD5 cc0d81cece1445afac536ec720bfa507
BLAKE2b-256 ea9fc8b84f9d7b360dc0d63afcafbfdc785c2c39da3b2e1c3525d99476438407

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocstrings_python-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 34.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 35509cbf90ea886e5f20bf16657470d92d93c54b83677282abebcdb806716d79
MD5 f2bbf74746379b8d9d2535a143ef4884
BLAKE2b-256 3a3970d7991bab5baf0477b8a572573d38352d3611b46b0041620ff19809bbf0

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