Fix most sphinx warnings - #2182
Merged
JeanChristopheMorinPerso merged 3 commits intoAug 23, 2026
Merged
Conversation
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2182 +/- ##
=======================================
Coverage 61.29% 61.29%
=======================================
Files 164 164
Lines 20568 20568
Branches 3575 3575
=======================================
Hits 12607 12607
Misses 7089 7089
Partials 872 872 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Improves Sphinx API documentation and suppresses warnings from inherited and unresolved types.
Changes:
- Corrects docstring markup and cross-references.
- Expands generated API documentation.
- Filters noisy inherited-member warnings and enables parallel builds.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.gitignore |
Ignores generated vendor API pages. |
docs/Makefile |
Enables parallel builds and cleans vendor pages. |
docs/source/api.rst |
Adds plugin and vendored API entries. |
docs/source/conf.py |
Configures warning ignores and member filtering. |
src/rez/package_repository.py |
Documents the repository manager singleton. |
src/rez/rex.py |
Documents and types environment keys. |
src/rez/util.py |
Clarifies a return-value docstring. |
src/rez/utils/pip.py |
Corrects docstring type references. |
src/rezplugins/package_repository/memory.py |
Improves repository documentation markup. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Contributor
|
Confirmed I now only see the two warnings you mentioned. |
JeanChristopheMorinPerso
merged commit Aug 23, 2026
73a094d
into
AcademySoftwareFoundation:main
64 checks passed
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
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.
This PR fixes most Sphinx warnings. This this, I was able to remove 115 warnings. There are only two warnings left:
These two warnings are bugs in Sphinx. The
autodocextension was recently rewritten and it seems to have a few bugs. The warnings don't affect the builds though, so it's all good.AI disclosure: This started out with an LLM, but I ended up abandoning all its suggestion and instead I did all the changes manually, all by myself. So everything in this PR is coming from my brain.