[docs] allow building of python docstrings without generating HTML docs #2575
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.
Description of Change(s)
For those interested in only the python docstrings, this speeds up the build, and reduces the number of necessary extra dependencies (ie, graphviz / dot are no longer required to build python docstrings).
Doxygen is still needed to generate python docstrings, however, as the xml generation is required.
The interface for
build_usd.py
is mostly unchanged, except that--build-docs
and--build-python-docs
are now independent of each other - ie, you can now specify--build-python-docs
without--build-docs
, which will generate just the python docstrings and no html.At the cmake level, there are now 3 options:
PXR_BUILD_DOCUMENTATION
PXR_BUILD_HTML_DOCUMENTATION
(new)PXR_BUILD_PYTHON_DOCUMENTATION
Both
PXR_BUILD_HTML_DOCUMENTATION
andPXR_BUILD_PYTHON_DOCUMENTATION
will only have an effect ifPXR_BUILD_DOCUMENTATION
set. Setting either of thebuild_usd.py
documentation flags (--build-docs
and--build-python-docs
) will turn onPXR_BUILD_DOCUMENTATION
, as well as their own sub-flag.Both the
build_usd.py
and cmake interfaces are backwards compatible, in the sense that non-erroring combinations of flags/options will still continue to have the same result as previously.NOTE:
This PR is one of several targeting the python docstring generation process. To see all these PRs in a branch, see here.