Conversation
Preparing to use Markdown in the documentation.
Assuming this guidance will be most useful for anyone new to pixi, let's make it explicit to help them to memorize it, thus `pixi run` instead of `pixi r`. With time they'll learn more efficient ways of doing it.
c3c2adf to
396ad6f
Compare
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR improves the development documentation and Sphinx configuration to support additional documentation formats (notably Markdown via MyST).
Changes:
- Add
myst-parseras a docs dependency and enablemyst_parserin Sphinx extensions. - Update Sphinx
source_suffixconfiguration to recognize multiple file types. - Make minor dev-doc fixes/clarifications (maintainer name, ruff note,
pixi runcommand).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pyproject.toml | Adds myst-parser to the documentation dependency set. |
| docs/source/dev/README.rst | Updates contributor contact info and refines local testing instructions. |
| docs/source/conf.py | Enables MyST and expands recognized documentation source suffixes. |
ppinchuk
left a comment
There was a problem hiding this comment.
I think this needs to be rebased (or main merged into it) since it was opened so long ago.
Also the lock file needs to be updated
It was rebased. Did you see anything off? |
Following Copilot suggestion to avoid unintentional behavior.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #314 +/- ##
=======================================
Coverage 55.60% 55.60%
=======================================
Files 61 61
Lines 5681 5681
Branches 531 531
=======================================
Hits 3159 3159
Misses 2475 2475
Partials 47 47
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
oh, no, that's my bad. I saw it was opened a long time ago but didn't see a merge or rebase commit so just assumed. Sorry about that! |
No description provided.