Giter VIP home page Giter VIP logo

rezbuild_utils's Introduction

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

rezbuild_utils's People

Contributors

mrlixm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.