Skip to content
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.

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

[docs] allow building of python docstrings without generating HTML docs #2575

Commits on Aug 7, 2023

  1. [docs] allow building of python docstrings without generating HTML docs

    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` and
    `PXR_BUILD_PYTHON_DOCUMENTATION` will only have an effect if
    `PXR_BUILD_DOCUMENTATION` set.  Setting either of the `build_usd.py`
    documentation flags (`--build-docs` and `--build-python-docs`) will turn
    on `PXR_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.
    pmolodo committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    a403a99 View commit details
    Browse the repository at this point in the history