Pin Sphinx<9 for doc builds#49
Merged
Merged
Conversation
sphinx-hoverxref is incompatible with Sphinx 9's config API, which broke Read the Docs builds that installed the latest unpinned Sphinx release. Co-authored-by: Cursor <cursoragent@cursor.com>
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## develop #49 +/- ##
============================================
- Coverage 89.37% 73.73% -15.65%
============================================
Files 13 13
Lines 3088 3088
============================================
- Hits 2760 2277 -483
- Misses 328 811 +483 🚀 New features to boost your workflow:
|
Autodoc resolves pxr.Usd.PrimCompositionQuery.Filter to UsdPrimCompositionQueryFilter, which was not in the C++ name mapping and crashed RTD builds during api.rst output. Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Christian López Barrón <chris.gfz@gmail.com>
Autodoc normalizes the nested enum to UsdStageInitialLoadSet, which was not covered by the legacy UsdInitialLoadSet mapping used by fetch_stage signatures. Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Christian López Barrón <chris.gfz@gmail.com>
… for when to add new ones Signed-off-by: Christian López Barrón <chris.gfz@gmail.com>
3 tasks
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.
Pin
sphinx>=7.2,<9as 9 causes a failure:which comes through
sphinx-hoverxref(which has been archived) relying on_Optconfig API.Local docs build:
pip install -e .[docs,create]thenpython docs/source/build_docs.py