Skip to content

Pin Sphinx<9 for doc builds#49

Merged
chrizzFTD merged 6 commits into
developfrom
fix/sphinx-docs-pin
Jun 8, 2026
Merged

Pin Sphinx<9 for doc builds#49
chrizzFTD merged 6 commits into
developfrom
fix/sphinx-docs-pin

Conversation

@chrizzFTD

@chrizzFTD chrizzFTD commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator
  • Pin sphinx>=7.2,<9 as 9 causes a failure:

     sphinx.errors.ExtensionError: Handler <function deprecated_configs_warning at 0x7c5433104fe0> for event 'config-inited' threw an exception (exception: cannot unpack non-iterable _Opt object)

    which comes through sphinx-hoverxref (which has been archived) relying on _Opt config API.

  • Local docs build: pip install -e .[docs,create] then python docs/source/build_docs.py

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 <[email protected]>
@chrizzFTD chrizzFTD changed the base branch from main to develop June 7, 2026 01:32
@codecov

codecov Bot commented Jun 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.73%. Comparing base (655b0f7) to head (7484980).

❗ There is a different number of reports uploaded between BASE (655b0f7) and HEAD (7484980). Click for more details.

HEAD has 5 uploads less than BASE
Flag BASE (655b0f7) HEAD (7484980)
6 1
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     

see 8 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

chrizzFTD and others added 5 commits June 7, 2026 11:39
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 <[email protected]>
Signed-off-by: Christian López Barrón <[email protected]>
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 <[email protected]>
Signed-off-by: Christian López Barrón <[email protected]>
… for when to add new ones

Signed-off-by: Christian López Barrón <[email protected]>
@chrizzFTD chrizzFTD marked this pull request as ready for review June 8, 2026 00:38
@chrizzFTD chrizzFTD changed the title Pin Sphinx below 9 for RTD docs builds Pin Sphinx<9 for doc builds Jun 8, 2026
@chrizzFTD chrizzFTD merged commit cdb6e2d into develop Jun 8, 2026
4 of 7 checks passed
@chrizzFTD chrizzFTD deleted the fix/sphinx-docs-pin branch June 8, 2026 01:49
@chrizzFTD chrizzFTD mentioned this pull request Jul 4, 2026
3 tasks
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