Skip to content

Conversation

@douglatornell
Copy link
Member

@douglatornell douglatornell commented Jan 22, 2026

  • Initialize Pixi in pixi.toml
  • Import environment-rtd.yaml to provide dependencies for default environment
  • Add commonmark, recommonmark & readthedocs-sphinx-ext as PyPI dependencies for builds on readthedocs
  • Add check-toml hook to pre-commit configuration
  • Add Pixi tasks to build HTML docs and run sphinx linkcheck
  • Exclude .pixi/ from directories in which Sphinx looks for source files
  • Change GitHub Actions sphinx-linkcheck workflow to use reusable Pixi workflow
  • Change .readthedocs.yaml to use customized build process for Pixi from readthedocs build config docs
  • Drop envs/environment.yaml because it is no longer needed
  • Add task to update requirements.txt via pip list
  • Update contributing docs re: the use of Pixi for package and environments management
  • Add Pixi badge to README and dev docs

The requirements.txt file is retained so that we will continue to get security update notifications and PRs from dependabot. It will be dropped when dependabot adds support for the pixi.lock file.

Imported `environment.yaml` as default environment.
Added `commonmark`, `recommonmark`, and
`readthedocs-sphinx-ext` as PyPI dependencies for building on
readthedocs.
Added pixi settings to `pixi.toml` for dependencies, and
workspace specifications. Configured `.gitattributes` for pixi lock
files and updated `.gitignore` to exclude pixi directories while
allowing the configuration file.
@douglatornell douglatornell changed the title Initialize Pixi workspace Change to use Pixi for package & environment management Jan 22, 2026
@douglatornell douglatornell added documentation Improvements or additions to documentation enhancement New feature or request maintenance Codebase & repo maintenance labels Jan 22, 2026
- Switched to Pixi-based environment creation and installation.
- Updated build processes to leverage Pixi tasks for building docs.
- Changed Python version to "latest".
Dropped the environment file as it is no longer required. It has been
replaced by the default Pixi environment and a Pixi-customized
build process in `.readthedocs.yaml`.
* Added task to update `requirements.txt` via `pip list`

The `requirements.txt` file is retained so that we will continue to get
security update notifications and PRs from dependabot. It will be
dropped when dependabot adds support for the `pixi.lock` file.
- Use `pixi run` tasks to build html docs and run link checker
Added a shield.io Pixi badge to the README. The badge links to the
latest Pixi version and improves visibility of the Pixi integration.
@douglatornell douglatornell merged commit 4fcb612 into main Jan 22, 2026
3 checks passed
@douglatornell douglatornell deleted the pixi branch January 22, 2026 22:56
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 enhancement New feature or request maintenance Codebase & repo maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants