Skip to content

Conversation

@JeanChristopheMorinPerso
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso commented Jan 3, 2026

Fix Sphinx warnings caused by duplicate symbols by introducing two new Sphinx domains: rex and pkgdef.

This makes it possible to reference package attributes in the docs using :pkgdef:attr for example, and stuff in commands using :rex:attr.

This removes any duplicates in symbols. These new domains won't affect users reading our docs in any way, but it will have an impact on any user that are cross-linking our docs using intersphinx (https://docs.readthedocs.com/platform/latest/guides/intersphinx.html). These users will have to update references to :data:version, etc to use our domains instead.

I also fixed some more warnings that were not related to the duplicate symbols, and modified the CLI docs auto-generation code to improve the readability of the docs a little bit (please look at https://rez--2062.org.readthedocs.build/en/2062/commands_index.html?readthedocs-diff=true to visualize the diff).

AI disclosure:

The custom domains code was written using Amp. Here are the threads:

…w Sphinx domains: rex and pkgdef.

Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
@codecov
Copy link

codecov bot commented Jan 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.00%. Comparing base (a0d2ddb) to head (a2e6053).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2062   +/-   ##
=======================================
  Coverage   59.99%   60.00%           
=======================================
  Files         163      163           
  Lines       20118    20118           
  Branches     3519     3519           
=======================================
+ Hits        12070    12071    +1     
+ Misses       7227     7226    -1     
  Partials      821      821           

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

Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
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.

1 participant