Skip to content

Update docs about pixi #2959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sbonaretti wants to merge 1 commit into from
+16 −7
Closed

Update docs about pixi #2959

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 16 additions & 7 deletions docs/deployment-gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ This page has important information for how to do so.

## 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.

@choldgraf choldgraf Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

If you use pixi, make sure that the pixi project is initialized in the same root directory as your project (`pixi init`).

@choldgraf choldgraf Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we link to the install instructions in the myst guide for pixi, with a myst cross-ref?


Create a file called `.gitlab-ci.yml` with the following content:


Expand Down Expand Up @@ -125,19 +127,19 @@ pages:
```
````
`````
*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. -->

@choldgraf choldgraf Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this intentionally commented out? Why not just remove it, or include it in the content?


You must set the `HOST` - this is a fix for a [known issue](https://github.com/jupyter-book/mystmd/issues/2471).

Note that a [pixi.toml](https://pixi.prefix.dev/latest/python/pyproject_toml/) and pixi.lock file should be included!

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/).

@choldgraf choldgraf Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

You will need to modify the `pixi.toml` file with the following content:

```{code-block} toml
:filename: pixi.toml

[workspace]
authors = [{name = "Me", email = "me@me.com"}]
authors = ["Me <me@me.com>"]
channels = ["conda-forge"]
name = "jbtest"
platforms = ["win-64", "linux-64"]
Expand All @@ -149,6 +151,13 @@ version = "0.1.0"
python = ">=3.14.3,<3.15"
jupyter-book = ">=2.1.2,<3"
```
*Note*: In `authors = ["Me <me@me.com>"]`, update `Me` with your name and `<me@me.com>` with your email.

If you use pixi, create a third file `pixi.lock` using the command `pixi lock`.

At the end, push `.gitlab-ci.yml`, `pixi.toml` and `pixi lock` to your GitLab repo. Your site will be built using GitLab CI/CD.





Expand Down