Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,20 @@
# Contributing to mkdocstrings-python-xref

This project's environment and developemtn tasks are managed using [pixi]
(previously it used conda and make).

## Prerequisites

* [install pixi][pixi-install]

## Development setup

To (re)create a pixi development environment for this project, from inside
the source tree run:

```
pixi reinstall
```
* [pixi][pixi] [must be installed][pixi-install] on your machine

This is actually optional, since pixi will automatically install the
environment the first time you run a command.
## Development tasks

See `pixi task list` for a list of available tasks.
All development tasks are managed using [pixi][pixi].
Use `pixi task list` to see the available tasks.

## Versioning

The versions will generally track the version of [mkdocstrings_python][] on which it depends.

[pixi]: https://pixi.sh/dev/
[pixi-install]: https://pixi.sh/dev/advanced/installation/
[mkdocstrings_python]: https://github.com/mkdocstrings/python


[pixi]: https://pixi.sh/latest/
[pixi-install]: https://pixi.sh/latest/installation/
5 changes: 0 additions & 5 deletions MANIFEST.in

This file was deleted.

245 changes: 0 additions & 245 deletions Makefile

This file was deleted.

25 changes: 0 additions & 25 deletions environment.yml

This file was deleted.

Loading
Loading