Skip to content

Development docs - minor improvements#314

Open
castelao wants to merge 8 commits intomainfrom
development_docs
Open

Development docs - minor improvements#314
castelao wants to merge 8 commits intomainfrom
development_docs

Conversation

@castelao
Copy link
Copy Markdown
Member

No description provided.

@castelao castelao added this to the Finishing touches for OSS milestone Oct 21, 2025
@castelao castelao self-assigned this Oct 21, 2025
@castelao castelao added the documentation Improvements or additions to documentation label Oct 21, 2025
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.
@castelao castelao marked this pull request as ready for review April 10, 2026 20:34
@castelao castelao requested a review from ppinchuk as a code owner April 10, 2026 20:34
Copilot AI review requested due to automatic review settings April 10, 2026 20:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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-parser as a docs dependency and enable myst_parser in Sphinx extensions.
  • Update Sphinx source_suffix configuration to recognize multiple file types.
  • Make minor dev-doc fixes/clarifications (maintainer name, ruff note, pixi run command).

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.

Copy link
Copy Markdown
Collaborator

@ppinchuk ppinchuk left a comment

Choose a reason for hiding this comment

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

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

@castelao
Copy link
Copy Markdown
Member Author

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-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.60%. Comparing base (daac6d4) to head (f74ee76).
⚠️ Report is 2 commits behind head on main.

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           
Flag Coverage Δ
unittests 55.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ppinchuk
Copy link
Copy Markdown
Collaborator

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?

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants