Installation

Installation may follow one of two paths: deployment or development. Choose the relevant tab for details on each of those installation paths.

Deployment (pip/uv)

Install using pip, or your preferred Python project management solution (e.g. uv, rye or poetry).

Stable release, from PyPI:

pip install auto-intersphinx

Latest development branch, from its git repository:

pip install git+https://github.com/idiap/auto-intersphinx@main

Deployment (pixi)

Use pixi to add this package as a dependence:

pixi add auto-intersphinx

Development

Checkout the repository, and then use pixi to setup a full development environment:

git clone git@github.com:idiap/auto-intersphinx
pixi install --frozen

Tip

The --frozen flag will ensure that the latest lock-file available with sources is used. If you’d like to update the lock-file to the latest set of compatible dependencies, remove that option.

If you use direnv to setup your pixi environment when you enter the directory containing this package, you can use a .envrc file similar to this:

watch_file pixi.lock
export PIXI_FROZEN="true"
eval "$(pixi shell-hook)"