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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocstrings-python-0.2.0.tar.gz
  • Upload date:
  • Size: 17.8 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.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for mkdocstrings-python-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a1598dfd95ec7a7b87c369f07b8a5203fb92d454f46588917e7a8909acbc0a42
MD5 091593df05e90454305827d1ec41308b
BLAKE2b-256 297ce74dc3ab6c5c7f0d3cb8a59c7028a9d2fb8067df83e7f671846785ae0510

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocstrings_python-0.2.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.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for mkdocstrings_python-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 191c1e2b5b7ea96fd6d073785b31183fa333843447a85e297a07337cfece81e5
MD5 e298ebb96e85bf0503a5d61a93c434c9
BLAKE2b-256 ea327d5c5ed6d7ff30131ec6d88ecca013f8766d61a30380dc140e2aeba607e0

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