From f067f9488533e3a0428d4d63eafa82cfe68c073d Mon Sep 17 00:00:00 2001 From: Luca Scheller Date: Tue, 3 Oct 2023 19:05:06 +0200 Subject: [PATCH] Fix build name and typos mentioned in PR 4 --- .github/workflows/build_houdini.yml | 2 +- README.md | 2 +- docs.bat | 8 +++++--- docs.sh | 8 +------- docs/src/resolvers/ExampleSetup/overview.md | 10 +++++----- files/box.usda | 2 +- files/cylinder.usda | 2 +- files/workspace/assets/assetA/assetA.usd | 2 +- files/workspace/assets/assetA/assetA_v001.usd | 2 +- files/workspace/assets/assetA/assetA_v002.usd | 2 +- files/workspace/shots/shotA/shotA.usd | 2 +- 11 files changed, 19 insertions(+), 23 deletions(-) diff --git a/.github/workflows/build_houdini.yml b/.github/workflows/build_houdini.yml index 948370f..3df49ff 100644 --- a/.github/workflows/build_houdini.yml +++ b/.github/workflows/build_houdini.yml @@ -1,4 +1,4 @@ -name: Build USD Asset Resolvers against Houdini +name: Build USD Asset Resolvers against Houdini (Linux/Windows) on: release: diff --git a/README.md b/README.md index b3d47e8..d1c034e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This repository holds reference implementations for [Usd](https://openusd.org/re ## Installation To build the various resolvers, follow the instructions in the [install guide](https://lucascheller.github.io/VFX-UsdAssetResolver/installation/requirements.html). -> :info: This guide currently covers compiling against Houdini on Linux and Windows. Alternatively you can also download a pre-compiled builds on our [release page](https://github.com/LucaScheller/VFX-UsdAssetResolver/releases). To load the resolver, you must specify a few environment variables, see our [environment variables](https://lucascheller.github.io/VFX-UsdAssetResolver/resolvers/overview.html#environment-variables) section for more details. Alternatively you can also source the setup.sh file in the root of this repo when working in Linux to get a pre-configured environment. +> [!IMPORTANT] This guide currently covers compiling against Houdini on Linux and Windows. Alternatively you can also download a pre-compiled builds on our [release page](https://github.com/LucaScheller/VFX-UsdAssetResolver/releases). To load the resolver, you must specify a few environment variables, see our [environment variables](https://lucascheller.github.io/VFX-UsdAssetResolver/resolvers/overview.html#environment-variables) section for more details. Alternatively you can also source the setup.sh file in the root of this repo when working in Linux to get a pre-configured environment. ## Feature Overview diff --git a/docs.bat b/docs.bat index d6da387..0e0626c 100644 --- a/docs.bat +++ b/docs.bat @@ -1,4 +1,6 @@ -REM Clean existing builds -rmdir %~dp0docs\book /S /Q +REM Source setup +set REPO_ROOT=%~dp0 +REM Clean existing build +rmdir %REPO_ROOT%docs\book /S /Q REM Build book -mdbook serve --open %~dp0\docs \ No newline at end of file +mdbook serve --open %REPO_ROOT%docs \ No newline at end of file diff --git a/docs.sh b/docs.sh index fd12212..20ee7c1 100755 --- a/docs.sh +++ b/docs.sh @@ -1,12 +1,6 @@ # Source setup export REPO_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && (pwd -W 2> /dev/null || pwd)) -# Clean existing builds +# Clean existing build rm -R ${REPO_ROOT}/docs/book -# Build Python code based on doc strings. This only needs to be done on API changes. -# Generate python venv -# $HFS/python/bin/python -m venv ${REPO_ROOT}/tools/python -# source ${REPO_ROOT}/tools/python/bin/activate -# python -m pip install pydoc-markdown -# This is currently not being used as pydoc-markdown fails to detect all docstrings. # Build book mdbook serve --open ${REPO_ROOT}/docs diff --git a/docs/src/resolvers/ExampleSetup/overview.md b/docs/src/resolvers/ExampleSetup/overview.md index 2859c99..697fe7b 100644 --- a/docs/src/resolvers/ExampleSetup/overview.md +++ b/docs/src/resolvers/ExampleSetup/overview.md @@ -40,7 +40,7 @@ Content of a USD file located at `/workspace/shots/shotA/shotA.usd` ```python #usda 1.0 def "testAssetA" ( - prepend references = @assetA/assetA.usd@ + prepend references = @assetA/assetA.usd@ ) { } @@ -56,18 +56,18 @@ Content of the USD file located at `/workspace/shots/shotA/shotA_mapping.usd` ) ``` -Content of the USD files located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v002.usd` +Content of the USD files located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v001.usd` ```python #usda 1.0 -def Cube "box" () +def Cube "asset" () { double size = 2 } ``` -Content of the USD file located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v001.usd` +Content of the USD file located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v002.usd` ```python #usda 1.0 -def Cylinder "box" () +def Cylinder "asset" () { } ``` \ No newline at end of file diff --git a/files/box.usda b/files/box.usda index ca66760..ade6c1b 100644 --- a/files/box.usda +++ b/files/box.usda @@ -1,5 +1,5 @@ #usda 1.0 -def Cube "box" () +def Cube "example" () { double size = 2 } \ No newline at end of file diff --git a/files/cylinder.usda b/files/cylinder.usda index 22afb1d..10afb4f 100644 --- a/files/cylinder.usda +++ b/files/cylinder.usda @@ -1,4 +1,4 @@ #usda 1.0 -def Cylinder "box" () +def Cylinder "example" () { } \ No newline at end of file diff --git a/files/workspace/assets/assetA/assetA.usd b/files/workspace/assets/assetA/assetA.usd index ca66760..a136181 100644 --- a/files/workspace/assets/assetA/assetA.usd +++ b/files/workspace/assets/assetA/assetA.usd @@ -1,5 +1,5 @@ #usda 1.0 -def Cube "box" () +def Cube "asset" () { double size = 2 } \ No newline at end of file diff --git a/files/workspace/assets/assetA/assetA_v001.usd b/files/workspace/assets/assetA/assetA_v001.usd index ca66760..a136181 100644 --- a/files/workspace/assets/assetA/assetA_v001.usd +++ b/files/workspace/assets/assetA/assetA_v001.usd @@ -1,5 +1,5 @@ #usda 1.0 -def Cube "box" () +def Cube "asset" () { double size = 2 } \ No newline at end of file diff --git a/files/workspace/assets/assetA/assetA_v002.usd b/files/workspace/assets/assetA/assetA_v002.usd index 22afb1d..63fbef7 100644 --- a/files/workspace/assets/assetA/assetA_v002.usd +++ b/files/workspace/assets/assetA/assetA_v002.usd @@ -1,4 +1,4 @@ #usda 1.0 -def Cylinder "box" () +def Cylinder "asset" () { } \ No newline at end of file diff --git a/files/workspace/shots/shotA/shotA.usd b/files/workspace/shots/shotA/shotA.usd index 2c7cf3f..a35e6ff 100644 --- a/files/workspace/shots/shotA/shotA.usd +++ b/files/workspace/shots/shotA/shotA.usd @@ -1,6 +1,6 @@ #usda 1.0 def "testAssetA" ( - prepend references = @assetA/assetA.usd@ + prepend references = @assetA/assetA.usd@ ) { } \ No newline at end of file