diff --git a/docs/source/conf.py b/docs/source/conf.py index 9437f877..f8a4d932 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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 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", diff --git a/setup.cfg b/setup.cfg index 6a2deb9b..6f56714a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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