File tree Expand file tree Collapse file tree 4 files changed +1957
-1116
lines changed Expand file tree Collapse file tree 4 files changed +1957
-1116
lines changed Original file line number Diff line number Diff line change 1
1
# Contributing to mkdocstrings-python-xref
2
2
3
+ This project's environment and developemtn tasks are managed using [ pixi]
4
+ (previously it used conda and make).
5
+
3
6
## Prerequisites
4
7
5
- * conda must be installed on your machine
6
- * make should be installed in your base conda environment
8
+ * [ install pixi] [ pixi-install ]
7
9
8
- ## Development install
10
+ ## Development setup
9
11
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:
11
14
12
15
```
13
- make createdev
14
- conda activate mkxref-dev
16
+ pixi reinstall
15
17
```
16
18
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.
25
21
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 .
27
23
28
24
## Versioning
29
25
@@ -32,3 +28,5 @@ The versions will generally track the version of [mkdocstrings_python][] on whic
32
28
[ mkdocstrings_python ] : https://github.com/mkdocstrings/python
33
29
34
30
31
+ [ pixi ] : https://pixi.sh/latest/
32
+ [ pixi-install ] : https://pixi.sh/latest/installation/
Original file line number Diff line number Diff line change
1
+ # This makefile is deprecated!
2
+
1
3
CONDA := conda
2
4
ECHO := echo
3
5
RM := rm
@@ -32,13 +34,8 @@ SRC_FILES := $(wildcard src/mkdocstrings_handlers/python_xref/*.py) $(PYTHON_VER
32
34
# Env names
33
35
DEV_ENV := mkxref-dev
34
36
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 )
42
39
43
40
# Testing args
44
41
PYTEST_ARGS :=
You can’t perform that action at this time.
0 commit comments