docs: Switchable toml code snippets#5656
Open
HARSHVARANDANI wants to merge 3 commits intoprefix-dev:mainfrom
Open
docs: Switchable toml code snippets#5656HARSHVARANDANI wants to merge 3 commits intoprefix-dev:mainfrom
HARSHVARANDANI wants to merge 3 commits intoprefix-dev:mainfrom
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
After
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:
Open the generated documentation in the browser and verify that the new pixi.toml / pyproject.toml tabbed code blocks render correctly.
Checklist: