Skip to content

Pin Sphinx<9 for doc builds #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrizzFTD merged 6 commits into from
Jun 8, 2026
Merged

Pin Sphinx<9 for doc builds #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
82f3c3e
Pin Sphinx below 9 for RTD docs builds.
chrizzFTD Jun 7, 2026
7335816
Fix doxylink aliases for nested PrimCompositionQuery Python types.
chrizzFTD Jun 7, 2026
691c00e
keep raising when doxylink fails
chrizzFTD Jun 7, 2026
651ba00
Add doxylink alias for pxr.Usd.Stage.InitialLoadSet.
chrizzFTD Jun 7, 2026
0d77236
update doc env snippet
chrizzFTD Jun 8, 2026
7484980
cleanup unneeded doxylunk namespace mapping entries and added comment…
chrizzFTD Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,13 @@ def _get_usd_ref_tooltip(app):
@functools.cache
def _get_url_for_usd_target(app, target):
pxr_obj_namespace = target.removeprefix('pxr.').replace(".", "")
# Some doxylink urls from python binding members not map directly yet.
# Add entries here for exceptions such as: LookupError: No documentation entry matching "UsdStageInitialLoadSet"
# Enclosed as:
# sphinx.errors.ExtensionError: Handler <function _handle_missing_usd_reference at 0x000001C8C34A5B10> for event 'missing-reference' threw an exception (exception: No documentation entry matching "UsdStageInitialLoadSet")
pxr_obj_namespace = {
"UsdInitialLoadSet": "UsdStage::InitialLoadSet", # there's indirection in the python bindings
"UsdFilter": "UsdPrimCompositionQuery::Filter", # filter is a member of the query type
"UsdStageInitialLoadSet": "UsdStage::InitialLoadSet",
"UsdPrimCompositionQueryFilter": "UsdPrimCompositionQuery::Filter",
"UsdCompositionArc": "UsdPrimCompositionQueryArc",
"Usd_Term": "primFlags.h",
"Usd_PrimFlagsConjunction": "primFlags.h",
Expand Down
15 changes: 13 additions & 2 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,23 @@ include = grill.*
# conda install conda-forge::graphviz=11 # 13.1.2 brings up libffi which messes up _ctypes from python-3.13, and 12 fails to load gvplugin_pango.dll
# python -m pip install grill-names>=2.6.0 networkx>=3.4 pydot>=3.0.1 numpy PyOpenGL pyside6
# docs dependencies:
# python -m pip install sphinx myst-parser sphinx-toggleprompt sphinx-copybutton sphinx-togglebutton sphinx-hoverxref>=1.4.1 sphinx_autodoc_typehints sphinx-inline-tabs shibuya sphinxcontrib-doxylink
# python -m pip install -U "sphinx>=7.2,<9" myst-parser sphinx-toggleprompt sphinx-copybutton sphinx-togglebutton "sphinx-hoverxref>=1.4.1" sphinx_autodoc_typehints sphinx-inline-tabs shibuya sphinxcontrib-doxylink
# For EDGEDB (coming up)
# python -m pip install edgedb
# To install packages in editable mode, cd to desired package repo, then:
# python -m pip install -e .

docs = sphinx; myst-parser; sphinx-toggleprompt; sphinx-copybutton; sphinx-togglebutton; sphinx-hoverxref>=1.4.1; sphinx_autodoc_typehints; sphinx-inline-tabs; shibuya; usd-core; sphinxcontrib-doxylink
docs =
sphinx>=7.2,<9
myst-parser
sphinx-toggleprompt
sphinx-copybutton
sphinx-togglebutton
sphinx-hoverxref>=1.4.1,<2
sphinx_autodoc_typehints
sphinx-inline-tabs
shibuya
usd-core
sphinxcontrib-doxylink
full = PySide6; usd-core; PyOpenGL
create = grill-names>=2.6.0
Loading