Installation¶

Installing alongside mkdocstrings-python

You don't need to explicitly specify mkdocstrings-python as a dependency, as this package already lists it as it's internal dependency, which means installing mkdocstrings-python-betterrefs will also install mkdocstrings-python for you.

PyPI (stable) version¶

mkdocstrings-python-betterrefs is available on PyPI and can be installed like any other python library with:

pip poetry rye uv pdm

pip install mkdocstrings-python-betterrefs

pip is the main package installer for Python.

poetry add mkdocstrings-python-betterrefs

Poetry is an all-in-one solution for Python project management.

rye add mkdocstrings-python-betterrefs

Rye is an all-in-one solution for Python project management, written in Rust.

uv pip install mkdocstrings-python-betterrefs

uv is an ultra fast dependency resolver and package installer, written in Rust.

pdm add mkdocstrings-python-betterrefs

PDM is an all-in-one solution for Python project management.

Latest (git) version¶

We don't guarantee stability with method of installing

If you wish to install the latest available version (the one you currently see in the main git branch), you may instead choose this method of installing.

This kind of installation should only be done if you wish to test some new unreleased features and it's likely that you will encounter bugs.

That said, this library is still in development, and there may be some features that you might wish to try, even though they're not yet available in the latest release. This method of installation allows you to do just that.

To install the latest version of mkdocstrings-python-betterrefs directly from the main git branch, use: