rezbuild_utils

Python library providing utilities to build rez packages.

import rezbuild_utils
help(rezbuild_utils)

prerequisites

• python 3
• this is a rez package made to work in the context of a rez infrastructure.
• documentation need git to be deployed

documentation

https://knotsanimation.github.io/rezbuild_utils/

local build

cd .
# ensure package is built first (necessary for autodoc)
rez-build -i
rez-env sphinx furo rezbuild_utils
python ./doc/build-doc.py -a

The documentation can then be found in ./doc/build/html/index.html

publish

Deploy the documentation to GitHub pages.

You must:

• be on main branch
• have no uncommited changes
• have pushed the branch

cd .
# ensure package is built first (necessary for autodoc)
rez-build -i
rez-env sphinx furo rezbuild_utils
python ./doc/publish-doc.py