docs: Add pixi setup instructions to general use tutorial#3382
docs: Add pixi setup instructions to general use tutorial#3382johanneskoester merged 3 commits intosnakemake:mainfrom
Conversation
📝 WalkthroughWalkthroughThis pull request updates the documentation environment by adding the Changes
Suggested reviewers
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
docs/tutorial/setup.rst (3)
19-21: New Pixi Reference Links Added
The new reference links for Pixi (_Pixi, _Pixi installation, and _Pixi automated switching) have been added correctly. Please verify that these URLs match the latest Pixi documentation.
77-81: Clarification on Installation Options
The text now clearly differentiates between using the Pixi package management tool and the Miniforge distribution. Consider reviewing the punctuation and phrasing (e.g., removing the comma after "up") for improved readability.
136-155: Step 1a: Installing Pixi Instructions
The Pixi installation steps are well documented, and the command$ curl -fsSL https://pixi.sh/install.sh | bashis clear and concise. For added security assurance, consider advising users to review the installation script (or check its checksum) prior to running it.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
doc-environment.yml(1 hunks)docs/conf.py(1 hunks)docs/requirements.txt(1 hunks)docs/tutorial/setup.rst(6 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- doc-environment.yml
- docs/requirements.txt
- docs/conf.py
🔇 Additional comments (3)
docs/tutorial/setup.rst (3)
126-133: New Section Heading for Installation Options
The new "Step 1: Installing Pixi or Miniforge" heading and the subsequent option selection text provide a clear introduction to the installation methods. Ensure that the anchor labels (tutorial-installing_pixi_andtutorial-installing_miniforge_) are correctly referenced later in the document.
156-172: Step 1b: Installing Miniforge Instructions
The instructions for downloading and running the Miniforge installer for various operating systems are comprehensive. Please double-check that the URLs (especially for the GitHub releases) are up-to-date.
238-242: Step 3: Creating an Environment - Dual Options
The updated section now properly distinguishes between setting up a Pixi environment and a Miniforge environment. The Pixi command$ pixi init --import environment.yamland the subsequent instructions clearly inform users of their choices. Verify that the anchor links (
tutorial-creating_environment_pixi_andtutorial-creating_environment_miniforge_) work as intended.
| .. tabs:: | ||
|
|
||
| .. group-tab:: Pixi | ||
|
|
||
| .. code:: console | ||
|
|
||
| $ exit | ||
|
|
||
| .. group-tab:: Miniforge | ||
|
|
||
| .. code:: console | ||
|
|
||
| $ conda deactivate | ||
| $ conda activate snakemake-tutorial | ||
|
|
There was a problem hiding this comment.
💡 Verification agent
❓ Verification inconclusive
Exit Command for Miniforge Environment Appears Incorrect
In the "exit the environment" instructions, the Miniforge tab shows:
$ conda activate snakemake-tutorial
This seems to be a mistake—exiting an environment typically involves using conda deactivate rather than reactivating it. Please review and correct this to ensure users receive accurate guidance.
Correct Miniforge Exit Command
The instructions for exiting the environment in the Miniforge tab appear incorrect. Instead of using:
$ conda activate snakemake-tutorial
please update it to:
$ conda deactivate
This change aligns the exit instructions with standard Conda usage and ensures consistency in our documentation.
There was a problem hiding this comment.
I think coderabbit is right here.
There was a problem hiding this comment.
@johanneskoester Thanks for confirming! I'll provide the correct code change needed to fix the Miniforge environment exit instructions.
[plan_code_changes]
@@ -323,7 +323,7 @@ To exit the environment, you can execute
.. code:: console
- $ conda activate snakemake-tutorial
+ $ conda deactivate
but **don't do that now**, since we finally want to start working with Snakemake :-).This change corrects the exit command for the Miniforge environment to use conda deactivate instead of conda activate snakemake-tutorial, which aligns with standard Conda usage for exiting environments.
|
@johanneskoester the dark mode issue should now be fixed |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/_static/custom.css (1)
22-39: Dark Mode Styling for Sphinx Tabs
The newly added CSS rules for dark mode styling of Sphinx tabs are clear and well-scoped. Using!importantensures that these styles effectively override defaults, but please verify that this approach won’t lead to unintended conflicts with future styles.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
doc-environment.yml(1 hunks)docs/conf.py(1 hunks)docs/requirements.txt(1 hunks)docs/tutorial/setup.rst(6 hunks)docs/_static/custom.css(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/requirements.txt
- docs/conf.py
- doc-environment.yml
🔇 Additional comments (6)
docs/tutorial/setup.rst (6)
19-21: New Pixi Reference Links Added
The new reference links for Pixi (.. _Pixi: https://pixi.sh/,.. _Pixi installation: https://pixi.sh/latest/#installation, and.. _Pixi automated switching: https://pixi.sh/latest/switching_from/conda/#automated-switching) are correctly integrated. Please ensure these URLs remain up to date as the Pixi documentation evolves.
77-81: Introducing Pixi as a Package Manager
This section clearly introduces Pixi as the recommended package management tool, while also providing Miniforge as an alternative. The instructions are concise and help guide the user in choosing their preferred setup option.
126-127: Clear Section Header for Installation Options
The new header “Step 1: Installing Pixi or Miniforge” along with its underlining visually separates the installation options and improves readability.
130-132: Option Selection Clarity
The prompt “Choose one of the following options” with inline links toPixi <tutorial-installing_pixi_>andMiniforge <tutorial-installing_miniforge_>clearly communicates the available paths, aiding users in navigating the setup process.
136-155: Pixi Installation Instructions are Informative
The instructions for installing Pixi, including the command$ curl -fsSL https://pixi.sh/install.sh | bashand the subsequent PATH update details, are well documented. Just ensure that the installation command remains valid and in sync with the official Pixi documentation as it evolves.
313-326: Incorrect Exit Command for Miniforge Environment
The instructions for exiting the environment in the Miniforge tab still show:$ conda activate snakemake-tutorialInstead, users should use
$ conda deactivateto properly exit the environment. This comment echoes previous feedback and should be corrected to avoid user confusion.
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/tutorial/setup.rst (1)
136-155: Detailed Pixi Installation Instructions
The "Step 1a: Installing Pixi" section provides a clear command for installation, along with an explanation of what the command does (downloading, extracting, and updating the PATH). Consider adding a brief security note advising users to review the install script (or check its signature) before running it.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
doc-environment.yml(1 hunks)docs/_static/custom.css(1 hunks)docs/conf.py(1 hunks)docs/requirements.txt(1 hunks)docs/tutorial/setup.rst(6 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/requirements.txt
- docs/conf.py
- doc-environment.yml
- docs/_static/custom.css
⏰ Context from checks skipped due to timeout of 90000ms (30)
- GitHub Check: testing (10, 3.12, bash)
- GitHub Check: testing (10, 3.11, bash)
- GitHub Check: testing (9, 3.12, bash)
- GitHub Check: testing (9, 3.11, bash)
- GitHub Check: testing (8, 3.12, bash)
- GitHub Check: testing (8, 3.11, bash)
- GitHub Check: testing (7, 3.12, bash)
- GitHub Check: testing (7, 3.11, bash)
- GitHub Check: testing (6, 3.12, bash)
- GitHub Check: testing (6, 3.11, bash)
- GitHub Check: testing (5, 3.12, bash)
- GitHub Check: testing-windows (10)
- GitHub Check: testing (5, 3.11, bash)
- GitHub Check: testing-windows (9)
- GitHub Check: testing (4, 3.12, bash)
- GitHub Check: testing-windows (8)
- GitHub Check: testing (4, 3.11, bash)
- GitHub Check: testing-windows (7)
- GitHub Check: testing (3, 3.12, bash)
- GitHub Check: testing-windows (6)
- GitHub Check: testing (3, 3.11, bash)
- GitHub Check: testing-windows (5)
- GitHub Check: testing (2, 3.12, bash)
- GitHub Check: testing-windows (4)
- GitHub Check: testing (2, 3.11, bash)
- GitHub Check: testing-windows (3)
- GitHub Check: testing (1, 3.12, bash)
- GitHub Check: testing-windows (2)
- GitHub Check: testing (1, 3.11, bash)
- GitHub Check: testing-windows (1)
🔇 Additional comments (9)
docs/tutorial/setup.rst (9)
19-21: New Pixi Reference Anchors Added
The new reference links for Pixi and its related installation documentation are correctly added and will help users quickly access the Pixi homepage, installation guide, and automated switching details.
77-83: Clear Presentation of Installation Options
This segment clearly introduces Pixi as the primary package management tool while still offering Miniforge as an alternative. The use of reference links (e.g.,Pixi_andMiniforge_) makes the documentation navigable and consistent.
126-134: Explicit Instruction for Choosing an Installation Method
The section now explicitly asks users to choose between installing via Pixi or Miniforge. The concise phrasing and proper formatting facilitate user understanding.
156-186: Comprehensive Miniforge Setup Steps
The "Step 1b: Installing Miniforge" section is well detailed with OS-specific instructions using tabs for Linux, MacOS (x86_64), and MacOS (arm64). This thoroughness ensures that users on different platforms have clear guidance.
238-241: Clear Differentiation for Environment Creation
The introductory text for environment creation now clearly states that the procedure varies based on whether the user is using Pixi or Miniforge. This clarity will help users find the appropriate instructions for their chosen tool.
242-254: Well-Documented Pixi Environment Initialization
The "Step 3a: Pixi environment" section succinctly explains how Pixi can import an environment from anenvironment.yamlfile, using the automated switching feature. The example command is clear and directly supports the documentation’s intent.
255-283: Thorough Miniforge Environment Setup Documentation
The "Step 3b: Miniforge environment" section provides clear, step-by-step instructions for creating an environment with Miniforge. The inclusion of alternative instructions for installing Mamba (if absent) adds value and ensures a smooth setup process.
287-309: Dual Environment Activation Commands
The tabbed instructions for environment activation effectively cater to both Pixi and Miniforge users. It’s clear thatpixi shellis used to launch the Pixi-managed environment andconda activate snakemake-tutorialfor Miniforge.
311-327: Corrected Exit Instructions for Environments
The exit instructions now correctly use$ exitfor Pixi and$ conda deactivatefor Miniforge, addressing the previously noted error with the Miniforge exit command. This change aligns with standard Conda usage.
🤖 I have created a release *beep* *boop* --- ## [9.0.0](v8.30.0...v9.0.0) (2025-03-14) ### ⚠ BREAKING CHANGES * Logging refactor & add LoggerPluginInterface ([#3107](#3107)) ### Features * [#3412](#3412) - keep shadow folder of failed job if --keep-incomplete flag is set. ([#3430](#3430)) ([22978c3](22978c3)) * add flag --report-after-run to automatically generate the report after a successfull workflow run ([#3428](#3428)) ([b0a7f03](b0a7f03)) * add flatten function to IO utils ([#3424](#3424)) ([67fa392](67fa392)) * add helper functions to parse input files ([#2918](#2918)) ([63e45a7](63e45a7)) * Add option to print redacted file names ([#3089](#3089)) ([ba4d264](ba4d264)) * add support for validation of polars dataframe and lazyframe ([#3262](#3262)) ([c7473a6](c7473a6)) * added support for rendering dag with mermaid js ([#3409](#3409)) ([7bf8381](7bf8381)) * adding --replace-workflow-config to fully replace workflow configs (from config: directive) with --configfile, instead of merging them ([#3381](#3381)) ([47504a0](47504a0)) * Dynamic module name ([#3401](#3401)) ([024dc32](024dc32)) * Enable saving and reloading IOCache object ([#3386](#3386)) ([c935953](c935953)) * files added in rule params with workflow.source_path will be available in used containers ([#3385](#3385)) ([a6e45bf](a6e45bf)) * Fix keep_local in storage directive and more freedom over remote retrieval behaviour ([#3410](#3410)) ([67b4739](67b4739)) * inherit parameters of use rule and extend/replace individual items them when using 'with' directive ([#3365](#3365)) ([93e4b92](93e4b92)) * Logging refactor & add LoggerPluginInterface ([#3107](#3107)) ([86f1d6e](86f1d6e)) * Maximal file size for checksums ([#3368](#3368)) ([b039f8a](b039f8a)) * Modernize package configuration using Pixi ([#3369](#3369)) ([77992d8](77992d8)) * multiext support for named input/output ([#3372](#3372)) ([05e1378](05e1378)) * optionally auto-group jobs via temp files in case of remote execution ([#3378](#3378)) ([cc9bba2](cc9bba2)) ### Bug Fixes * `--delete-all-output` ignores `--dry-run` ([#3265](#3265)) ([23fef82](23fef82)) * 3342 faster touch runs and warning messages for non-existing files ([#3398](#3398)) ([cd9c3c3](cd9c3c3)) * add default value to max-jobs-per-timespan ([#3043](#3043)) ([2959abe](2959abe)) * checkpoints inside modules are overwritten ([#3359](#3359)) ([fba3ac7](fba3ac7)) * Convert Path to IOFile ([#3405](#3405)) ([c58684c](c58684c)) * Do not perform storage object cleanup with --keep-storage-local-copies set ([#3358](#3358)) ([9a6d14b](9a6d14b)) * edgecases of source deployment in case of remote execution ([#3396](#3396)) ([5da13be](5da13be)) * enhance error message formatting for strict DAG-building mode ([#3376](#3376)) ([a1c39ee](a1c39ee)) * fix bug in checkpoint handling that led to exceptions in case checkpoint output was missing upon rerun ([#3423](#3423)) ([8cf4a2f](8cf4a2f)) * force check all required outputs ([#3341](#3341)) ([495a4e7](495a4e7)) * group job formatting ([#3442](#3442)) ([f0b10a3](f0b10a3)) * in remote jobs, upload storage in topological order such that modification dates are preserved (e.g. in case of group jobs) ([#3377](#3377)) ([eace08f](eace08f)) * only skip eval when resource depends on input ([#3374](#3374)) ([4574c92](4574c92)) * Prevent execution of conda in apptainer when not explicitly requested in software deployment method ([#3388](#3388)) ([c43c5c0](c43c5c0)) * print filenames with quotes around them in RuleException ([#3269](#3269)) ([6baeda5](6baeda5)) * Re-evaluation of free resources ([#3399](#3399)) ([6371293](6371293)) * ReadTheDocs layout issue due to src directory change ([#3419](#3419)) ([695b127](695b127)) * robustly escaping quotes in generated bash scripts (v2) ([#3297](#3297)) ([#3389](#3389)) ([58720bd](58720bd)) * Show apptainer image URL in snakemake report ([#3407](#3407)) ([45f0450](45f0450)) * Update ReadTheDocs configuration for documentation build to use Pixi ([#3433](#3433)) ([3f227a6](3f227a6)) ### Documentation * Add pixi setup instructions to general use tutorial ([#3382](#3382)) ([115e81b](115e81b)) * fix contribution section heading levels, fix docs testing setup order ([#3360](#3360)) ([051dc53](051dc53)) * fix link to github.com/snakemake/poetry-snakemake-plugin ([#3436](#3436)) ([ec6d97c](ec6d97c)) * fix quoting ([#3394](#3394)) ([b40f599](b40f599)) * fix rerun-triggers default ([#3403](#3403)) ([4430e23](4430e23)) * fix typo 'safe' -> 'save' ([#3384](#3384)) ([7755861](7755861)) * mention code formatting in the contribution section ([#3431](#3431)) ([e8682b7](e8682b7)) * remove duplicated 'functions'. ([#3356](#3356)) ([7c595db](7c595db)) * update broken links documentation ([#3437](#3437)) ([e3d0d88](e3d0d88)) * Updating contributing guidelines with new pixi dev setup ([#3415](#3415)) ([8e95a12](8e95a12)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: snakemake-bot <snakemake-bot-admin@googlegroups.com>
…3382) This adds the [sphinx-tabs](https://sphinx-tabs.readthedocs.io/en/latest/) plugin and uses it to document installing [`pixi`](https://pixi.sh/) and importing the conda/mamba `environment.yaml` from the general use tutorial. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced the documentation with support for tabbed content, offering a more engaging presentation. - Introduced an alternative installation option with a new package management tool, alongside the existing method. - **Documentation** - Updated the setup guide to include dedicated sections and clearer instructions for environment creation and activation using either installation approach. - Added references and installation steps for the Pixi package management tool. - **Style** - Implemented new dark mode styling for Sphinx tabs, improving visual consistency in dark themes. - **Chores** - Added `sphinx-tabs` dependency to the documentation environment configuration. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
🤖 I have created a release *beep* *boop* --- ## [9.0.0](snakemake/snakemake@v8.30.0...v9.0.0) (2025-03-14) ### ⚠ BREAKING CHANGES * Logging refactor & add LoggerPluginInterface ([snakemake#3107](snakemake#3107)) ### Features * [snakemake#3412](snakemake#3412) - keep shadow folder of failed job if --keep-incomplete flag is set. ([snakemake#3430](snakemake#3430)) ([22978c3](snakemake@22978c3)) * add flag --report-after-run to automatically generate the report after a successfull workflow run ([snakemake#3428](snakemake#3428)) ([b0a7f03](snakemake@b0a7f03)) * add flatten function to IO utils ([snakemake#3424](snakemake#3424)) ([67fa392](snakemake@67fa392)) * add helper functions to parse input files ([snakemake#2918](snakemake#2918)) ([63e45a7](snakemake@63e45a7)) * Add option to print redacted file names ([snakemake#3089](snakemake#3089)) ([ba4d264](snakemake@ba4d264)) * add support for validation of polars dataframe and lazyframe ([snakemake#3262](snakemake#3262)) ([c7473a6](snakemake@c7473a6)) * added support for rendering dag with mermaid js ([snakemake#3409](snakemake#3409)) ([7bf8381](snakemake@7bf8381)) * adding --replace-workflow-config to fully replace workflow configs (from config: directive) with --configfile, instead of merging them ([snakemake#3381](snakemake#3381)) ([47504a0](snakemake@47504a0)) * Dynamic module name ([snakemake#3401](snakemake#3401)) ([024dc32](snakemake@024dc32)) * Enable saving and reloading IOCache object ([snakemake#3386](snakemake#3386)) ([c935953](snakemake@c935953)) * files added in rule params with workflow.source_path will be available in used containers ([snakemake#3385](snakemake#3385)) ([a6e45bf](snakemake@a6e45bf)) * Fix keep_local in storage directive and more freedom over remote retrieval behaviour ([snakemake#3410](snakemake#3410)) ([67b4739](snakemake@67b4739)) * inherit parameters of use rule and extend/replace individual items them when using 'with' directive ([snakemake#3365](snakemake#3365)) ([93e4b92](snakemake@93e4b92)) * Logging refactor & add LoggerPluginInterface ([snakemake#3107](snakemake#3107)) ([86f1d6e](snakemake@86f1d6e)) * Maximal file size for checksums ([snakemake#3368](snakemake#3368)) ([b039f8a](snakemake@b039f8a)) * Modernize package configuration using Pixi ([snakemake#3369](snakemake#3369)) ([77992d8](snakemake@77992d8)) * multiext support for named input/output ([snakemake#3372](snakemake#3372)) ([05e1378](snakemake@05e1378)) * optionally auto-group jobs via temp files in case of remote execution ([snakemake#3378](snakemake#3378)) ([cc9bba2](snakemake@cc9bba2)) ### Bug Fixes * `--delete-all-output` ignores `--dry-run` ([snakemake#3265](snakemake#3265)) ([23fef82](snakemake@23fef82)) * 3342 faster touch runs and warning messages for non-existing files ([snakemake#3398](snakemake#3398)) ([cd9c3c3](snakemake@cd9c3c3)) * add default value to max-jobs-per-timespan ([snakemake#3043](snakemake#3043)) ([2959abe](snakemake@2959abe)) * checkpoints inside modules are overwritten ([snakemake#3359](snakemake#3359)) ([fba3ac7](snakemake@fba3ac7)) * Convert Path to IOFile ([snakemake#3405](snakemake#3405)) ([c58684c](snakemake@c58684c)) * Do not perform storage object cleanup with --keep-storage-local-copies set ([snakemake#3358](snakemake#3358)) ([9a6d14b](snakemake@9a6d14b)) * edgecases of source deployment in case of remote execution ([snakemake#3396](snakemake#3396)) ([5da13be](snakemake@5da13be)) * enhance error message formatting for strict DAG-building mode ([snakemake#3376](snakemake#3376)) ([a1c39ee](snakemake@a1c39ee)) * fix bug in checkpoint handling that led to exceptions in case checkpoint output was missing upon rerun ([snakemake#3423](snakemake#3423)) ([8cf4a2f](snakemake@8cf4a2f)) * force check all required outputs ([snakemake#3341](snakemake#3341)) ([495a4e7](snakemake@495a4e7)) * group job formatting ([snakemake#3442](snakemake#3442)) ([f0b10a3](snakemake@f0b10a3)) * in remote jobs, upload storage in topological order such that modification dates are preserved (e.g. in case of group jobs) ([snakemake#3377](snakemake#3377)) ([eace08f](snakemake@eace08f)) * only skip eval when resource depends on input ([snakemake#3374](snakemake#3374)) ([4574c92](snakemake@4574c92)) * Prevent execution of conda in apptainer when not explicitly requested in software deployment method ([snakemake#3388](snakemake#3388)) ([c43c5c0](snakemake@c43c5c0)) * print filenames with quotes around them in RuleException ([snakemake#3269](snakemake#3269)) ([6baeda5](snakemake@6baeda5)) * Re-evaluation of free resources ([snakemake#3399](snakemake#3399)) ([6371293](snakemake@6371293)) * ReadTheDocs layout issue due to src directory change ([snakemake#3419](snakemake#3419)) ([695b127](snakemake@695b127)) * robustly escaping quotes in generated bash scripts (v2) ([snakemake#3297](snakemake#3297)) ([snakemake#3389](snakemake#3389)) ([58720bd](snakemake@58720bd)) * Show apptainer image URL in snakemake report ([snakemake#3407](snakemake#3407)) ([45f0450](snakemake@45f0450)) * Update ReadTheDocs configuration for documentation build to use Pixi ([snakemake#3433](snakemake#3433)) ([3f227a6](snakemake@3f227a6)) ### Documentation * Add pixi setup instructions to general use tutorial ([snakemake#3382](snakemake#3382)) ([115e81b](snakemake@115e81b)) * fix contribution section heading levels, fix docs testing setup order ([snakemake#3360](snakemake#3360)) ([051dc53](snakemake@051dc53)) * fix link to github.com/snakemake/poetry-snakemake-plugin ([snakemake#3436](snakemake#3436)) ([ec6d97c](snakemake@ec6d97c)) * fix quoting ([snakemake#3394](snakemake#3394)) ([b40f599](snakemake@b40f599)) * fix rerun-triggers default ([snakemake#3403](snakemake#3403)) ([4430e23](snakemake@4430e23)) * fix typo 'safe' -> 'save' ([snakemake#3384](snakemake#3384)) ([7755861](snakemake@7755861)) * mention code formatting in the contribution section ([snakemake#3431](snakemake#3431)) ([e8682b7](snakemake@e8682b7)) * remove duplicated 'functions'. ([snakemake#3356](snakemake#3356)) ([7c595db](snakemake@7c595db)) * update broken links documentation ([snakemake#3437](snakemake#3437)) ([e3d0d88](snakemake@e3d0d88)) * Updating contributing guidelines with new pixi dev setup ([snakemake#3415](snakemake#3415)) ([8e95a12](snakemake@8e95a12)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: snakemake-bot <snakemake-bot-admin@googlegroups.com>



This adds the sphinx-tabs plugin and uses it to document installing
pixiand importing the conda/mambaenvironment.yamlfrom the general use tutorial.Summary by CodeRabbit
New Features
Documentation
Style
Chores
sphinx-tabsdependency to the documentation environment configuration.