Skip to content

Fix most sphinx warnings - #2182

Merged
JeanChristopheMorinPerso merged 3 commits into
AcademySoftwareFoundation:mainfrom
JeanChristopheMorinPerso:fix_sphinx_warnings
Aug 23, 2026
Merged

Fix most sphinx warnings#2182
JeanChristopheMorinPerso merged 3 commits into
AcademySoftwareFoundation:mainfrom
JeanChristopheMorinPerso:fix_sphinx_warnings

Conversation

@JeanChristopheMorinPerso

@JeanChristopheMorinPerso JeanChristopheMorinPerso commented Aug 9, 2026

Copy link
Copy Markdown
Member

This PR fixes most Sphinx warnings. This this, I was able to remove 115 warnings. There are only two warnings left:

<unknown>:1: WARNING: more than one target found for cross-reference 'Command': rez.command.Command, rez.rex.Command [ref.python]
<unknown>:1: WARNING: py:class reference target not found: ModuleType [ref.class]

These two warnings are bugs in Sphinx. The autodoc extension 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.

Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
@JeanChristopheMorinPerso
JeanChristopheMorinPerso requested a review from a team as a code owner August 9, 2026 01:21
@codecov

codecov Bot commented Aug 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.29%. Comparing base (5c598c5) to head (20c0770).
⚠️ Report is 5 commits behind head on main.

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.
📢 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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread src/rezplugins/package_repository/memory.py Outdated
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>
@sanikache

Copy link
Copy Markdown
Contributor

Confirmed I now only see the two warnings you mentioned.

copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
<unknown>:1: WARNING: more than one target found for cross-reference 'Command': rez.command.Command, rez.rex.Command [ref.python]
<unknown>:1: WARNING: py:class reference target not found: ModuleType [ref.class]
writing output... [100%] variants
generating indices... genindex py-modindex done
writing additional pages... search done
copying images... [100%] _static/pkg_path_anatomy.png
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.

The HTML pages are in _build/html.

@sanikache sanikache left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

@JeanChristopheMorinPerso
JeanChristopheMorinPerso merged commit 73a094d into AcademySoftwareFoundation:main Aug 23, 2026
64 checks passed
@JeanChristopheMorinPerso
JeanChristopheMorinPerso deleted the fix_sphinx_warnings branch August 23, 2026 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants