Update docs about pixi - #2959
Conversation
|
github-actions
Bot
added
the
documentation
choldgraf
left a comment
choldgraf
left a comment
There was a problem hiding this comment.
Thanks for the improvement - a few quick thoughts via comments! Lemme know if you have any questions or would like pointers.
| ## Instructions | ||
|
|
||
| To get setup with GitLab Pages, ensure that your repository is hosted in GitLab and you are in the root of the Git repository. | ||
| To get setup with GitLab Pages, ensure that your repository is hosted in GitLab and you are in the root of the Git repository. Also, make sure that you have [pixi](https://pixi.prefix.dev/latest/) or [poetry](https://python-poetry.org/) installed. |
There was a problem hiding this comment.
This makes it seem like you can only install myst with pixi or poetry - is this true? If not, we should say something like "We recommend using pixi or poetry, which we'll show in this tutorial"
|
|
||
| To get setup with GitLab Pages, ensure that your repository is hosted in GitLab and you are in the root of the Git repository. | ||
| To get setup with GitLab Pages, ensure that your repository is hosted in GitLab and you are in the root of the Git repository. Also, make sure that you have [pixi](https://pixi.prefix.dev/latest/) or [poetry](https://python-poetry.org/) installed. | ||
| If you use pixi, make sure that the pixi project is initialized in the same root directory as your project (`pixi init`). |
There was a problem hiding this comment.
Can we link to the install instructions in the myst guide for pixi, with a myst cross-ref?
| ````` | ||
| *Note*: When using pixi, if you are not in the main branch, substitute `main` (last line) with your branch name. | ||
|
|
||
| <!-- Also, remember to set the `HOST` (this is a fix for a [known issue](https://github.com/jupyter-book/mystmd/issues/2471)) - it's already set in the example above. --> |
There was a problem hiding this comment.
Is this intentionally commented out? Why not just remove it, or include it in the content?
|
|
||
| A minimal version is shown below. | ||
| <!-- Note that a [pixi.toml](https://pixi.prefix.dev/latest/python/pyproject_toml/) and pixi.lock file should be included! --> | ||
| If you use pixi, when you initialize the project (`pixi init`), you automatically create the file [`pixi.toml`](https://pixi.prefix.dev/latest/python/pyproject_toml/). |
There was a problem hiding this comment.
Here I'd suggest adding an "install myst with pixi" section elsewhere in the documentation (or at least the parts that aren't required for gitlab) and then cross-reference it here
|
Closing because the conversation is continuing at #2966 |
2 participants
Documentation regarding the use of pixi improved by Yehor Korotenko (@DobbiKov), David Chamont (@chavid), Marie Debacq, and Serena Bonaretti (@sbonaretti) at the #myst-education-2026 workshop