Fix sphinx warnings#2062
Draft
JeanChristopheMorinPerso wants to merge 4 commits intoAcademySoftwareFoundation:mainfrom
Draft
Fix sphinx warnings#2062JeanChristopheMorinPerso wants to merge 4 commits intoAcademySoftwareFoundation:mainfrom
JeanChristopheMorinPerso wants to merge 4 commits intoAcademySoftwareFoundation:mainfrom
Conversation
…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 Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
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.
Fix Sphinx warnings caused by duplicate symbols by introducing two new Sphinx domains:
rexandpkgdef.This makes it possible to reference package attributes in the docs using
:pkgdef:attrfor 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: