Misc Documentation updates #355
Merged
Conversation
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
ppinchuk
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation-related dependencies and tooling, including version bumps for Sphinx extensions, removal of unused dependencies, and the renaming of the documentation build task for consistency.
- Updated Sphinx extension versions with proper upper bounds for stability
- Removed unused
makeandjinja2-timePython dependencies from doc extras - Renamed documentation build task from
python-doctopython-docswithmake clean htmlcommand - Added a comprehensive glossary and updated documentation structure
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated doc dependency versions with proper bounds, removed unused make package, renamed task to python-docs with make clean html |
| pixi.lock | Removed unused dependencies (make, jinja2-time, arrow) from lockfile and updated package hashes |
| docs/source/index.rst | Added glossary to toctree and index references |
| docs/source/glossary.rst | Added new comprehensive glossary defining COMPASS terminology |
| docs/source/dev/README.rst | Updated documentation build command reference to use python-docs |
| docs/Makefile | Refactored to add explicit clean target with CLEAN_TARGETS variable |
| .github/workflows/docs.yml | Updated workflow to use renamed python-docs task |
| .github/copilot-instructions.md | Updated references to use python-docs task name |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #355 +/- ##
=======================================
Coverage 51.63% 51.63%
=======================================
Files 45 45
Lines 4303 4303
Branches 391 391
=======================================
Hits 2222 2222
Misses 2051 2051
Partials 30 30
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:
|
castelao
approved these changes
Dec 4, 2025
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.
An assortment of updates regarding documentation