Skip to content

Commit 9361c1e

Browse files
Update pixi configuration
1 parent 33053c0 commit 9361c1e

File tree

4 files changed

+1957
-1116
lines changed

4 files changed

+1957
-1116
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,25 @@
11
# Contributing to mkdocstrings-python-xref
22

3+
This project's environment and developemtn tasks are managed using [pixi]
4+
(previously it used conda and make).
5+
36
## Prerequisites
47

5-
* conda must be installed on your machine
6-
* make should be installed in your base conda environment
8+
* [install pixi][pixi-install]
79

8-
## Development install
10+
## Development setup
911

10-
To (re)create a conda development environment for this project run:
12+
To (re)create a pixi development environment for this project, from inside
13+
the source tree run:
1114

1215
```
13-
make createdev
14-
conda activate mkxref-dev
16+
pixi reinstall
1517
```
1618

17-
After you have created the environment for the first time, you can configure your IDE
18-
to use that for this project.
19-
20-
To update the environment after pulling or modifying project dependencies, you can use
21-
22-
```
23-
make updatedev
24-
```
19+
This is actually optional, since pixi will automatically install the
20+
environment the first time you run a command.
2521

26-
This is just an optimization. If it does not work (e.g. can happen when switching to an old branch), just use `createdev`.
22+
See `pixi task list` for a list of available tasks.
2723

2824
## Versioning
2925

@@ -32,3 +28,5 @@ The versions will generally track the version of [mkdocstrings_python][] on whic
3228
[mkdocstrings_python]: https://github.com/mkdocstrings/python
3329

3430

31+
[pixi]: https://pixi.sh/latest/
32+
[pixi-install]: https://pixi.sh/latest/installation/

Makefile

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# This makefile is deprecated!
2+
13
CONDA := conda
24
ECHO := echo
35
RM := rm
@@ -32,13 +34,8 @@ SRC_FILES := $(wildcard src/mkdocstrings_handlers/python_xref/*.py) $(PYTHON_VER
3234
# Env names
3335
DEV_ENV := mkxref-dev
3436

35-
# Whether to run targets in current env or explicitly in $(DEV_ENV)
36-
CURR_ENV_BASENAME := $(shell basename $(CONDA_PREFIX))
37-
ifeq ($(CURR_ENV_BASENAME), $(DEV_ENV))
38-
CONDA_RUN :=
39-
else
40-
CONDA_RUN := conda run -n $(DEV_ENV) --no-capture-output
41-
endif
37+
PIXI_RUN := pixi run
38+
CONDA_RUN := $(PIXI_RUN)
4239

4340
# Testing args
4441
PYTEST_ARGS :=

0 commit comments

Comments
 (0)