Skip to content

docs: Switchable toml code snippets#5656

Open
HARSHVARANDANI wants to merge 3 commits intoprefix-dev:mainfrom
HARSHVARANDANI:switchable-toml-code-snippets
Open

docs: Switchable toml code snippets#5656
HARSHVARANDANI wants to merge 3 commits intoprefix-dev:mainfrom
HARSHVARANDANI:switchable-toml-code-snippets

Conversation

@HARSHVARANDANI
Copy link

Description

This PR adds switchable pixi.toml / pyproject.toml code snippets across the documentation where only pixi.toml examples were previously shown.

The changes convert relevant manifest examples to also include their pyproject.toml equivalents (using the tool.pixi.* namespace where applicable) and present them using tabbed code blocks for easier comparison. Sections where the configuration is identical (e.g., [package.*] blocks) or where the content belongs to Pixi configuration rather than the project manifest were left unchanged.

This improves clarity for users who prefer using pyproject.toml while keeping existing pixi.toml examples intact.

Before

image

After

image

Fixes #4452

These changes only affect the documentation, so there are no dedicated tests for this functionality.

To verify the changes locally:

Run the documentation site locally:

pixi run docs

Open the generated documentation in the browser and verify that the new pixi.toml / pyproject.toml tabbed code blocks render correctly.

Checklist:

  • I have made corresponding changes to the documentation

Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
…oml formats and merge conflicts

Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
Signed-off-by: HARSHVARANDANI <hpvarandani@gmail.com>
@HARSHVARANDANI HARSHVARANDANI changed the title Switchable toml code snippets docs: Switchable toml code snippets Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Add switchable pyproject.toml / pixi.toml code snippets [on pages that don't already have them]

1 participant