Developing the Omniverse Documentation System

Before diving into the documentation system development, see How the Omniverse Documentation System Works.

Developing the Tool Locally

After cloning the repo, one can “source link” to the cloned copy from another repository. For example, if you have Carbonite cloned, you can run the following to have Carbonite use the locally cloned copy of repo_docs.

# assuming the cwd is /home/cournia/carbonite
repo source link repo_docs /home/ncournia/repo_docs

Publishing the Tool

To publish the tool to the public, first complete the following:

• Update VERSION

• Update CHANGES.md

Be sure to build the tool’s docs, which will ship as a part of the package:

repo docs

You can then create a test package:

repo upload -p

This will generate _build/packages/repo_docs@0.1.0.7z. Verify the files you expect to be in the package are present as follows:

7z l _build/packages/repo_docs@0.1.0.7z

You can then publish with:

# commit the version number
git commit -a -m "Bumped version to X.X.X"

# tag the version
git tag "X.X.X"

# push changes upstream
git push origin HEAD
git push --tags

# publish to the packman repo
repo upload