diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8b87810324..93928e8cf8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -49,17 +49,39 @@ jobs: ./ci/build.sh -v --build-type=Release --components="core,python,doc" - --cargs=\"-DUSE_BLOSC=OFF -DOPENVDB_CORE_STATIC=OFF -DOPENVDB_PYTHON_WRAP_ALL_GRID_TYPES=ON -DDISABLE_DEPENDENCY_VERSION_CHECKS=ON\" + --cargs=\" + -DUSE_BLOSC=OFF + -DOPENVDB_CORE_STATIC=OFF + -DOPENVDB_PYTHON_WRAP_ALL_GRID_TYPES=ON + -DUSE_EXPLICIT_INSTANTIATION=OFF + -DDISABLE_DEPENDENCY_VERSION_CHECKS=ON + \" - name: epydoc run: | epydoc --html -o /usr/local/share/doc/OpenVDB/html/python pyopenvdb + - name: pre_deploy + # Overwrite global SSH configuration + # https://github.com/peaceiris/actions-gh-pages/issues/719 + # https://linuxhint.com/ssh-stricthostkeychecking/ + run: > + echo "Host * + StrictHostKeyChecking no + UserKnownHostsFile=/dev/null + " > /etc/ssh/ssh_config - name: deploy - # only deploy documentation to gh-pages on a manual workflow dispatch + # only deploy documentation on a manual workflow dispatch if: | github.repository_owner == 'AcademySoftwareFoundation' && github.event_name == 'workflow_dispatch' && github.event.inputs.deploy == 'true' uses: peaceiris/actions-gh-pages@v3 with: - github_token: ${{ secrets.GITHUB_TOKEN }} + deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} publish_dir: /usr/local/share/doc/OpenVDB/html + destination_dir: documentation/doxygen + external_repository: AcademySoftwareFoundation/openvdb-website + publish_branch: doxygen + full_commit_message: "Automatic doxygen documentation update + - Deployed from: AcademySoftwareFoundation/openvdb ${{ github.sha }} + + Signed-off-by: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>" diff --git a/CHANGES b/CHANGES index cd37178872..b41600cf08 100644 --- a/CHANGES +++ b/CHANGES @@ -422,7 +422,7 @@ Version 8.0.0 - December 23, 2020 providing users with a new way of interacting with OpenVDB data. AX is tailored towards writing highly parallelizable and customizable OpenVDB volume and point kernel operations. See the documentation for more: - https://academysoftwarefoundation.github.io/openvdb/openvdbax.html + https://www.openvdb.org/documentation/openvdbax.html New features: - Added tools::anyActiveVoxels and tools::anyActiveTiles that check diff --git a/CMakeLists.txt b/CMakeLists.txt index d933e1c36f..f6588feed3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -18,12 +18,12 @@ and required dependencies are expected. See the dependency documentation for more information: - https://academysoftwarefoundation.github.io/openvdb/dependencies.html + https://www.openvdb.org/documentation/doxygen/dependencies.html And the documentation on building OpenVDB for more in depth installation instructions: - https://academysoftwarefoundation.github.io/openvdb/build.html + https://www.openvdb.org/documentation/doxygen/build.html This CMakeLists file provides most available options for configuring the build and installation of all OpenVDB components. By default the core diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09e5bcc5f7..1ee6eda8af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ The contributor role is the starting role for anyone participating in the projec ### Process for becoming a contributor -* Review the [coding standards](https://academysoftwarefoundation.github.io/openvdb/codingStyle.html) to ensure your contribution is in line with the project's coding and styling guidelines. +* Review the [coding standards](https://www.openvdb.org/documentation/doxygen/codingStyle.html) to ensure your contribution is in line with the project's coding and styling guidelines. * Have a signed CLA on file ( see [below](#contributor-license-agreements) ) * Submit your code as a PR with the appropriate [DCO sign-off](#commit-sign-off). * Have your submission approved by the [committer(s)](#committer) and merged into the codebase. diff --git a/README.md b/README.md index 57dc90523d..15a5a41b1e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ [Website](https://www.openvdb.org) | [Discussion Forum](https://github.com/AcademySoftwareFoundation/openvdb/discussions) | -[Documentation](https://academysoftwarefoundation.github.io/openvdb) +[Documentation](https://www.openvdb.org/documentation/doxygen) OpenVDB is an open source C++ library comprising a novel hierarchical data structure and a large suite of tools for the efficient storage and manipulation of sparse volumetric data discretized on three-dimensional grids. It was developed by DreamWorks Animation for use in volumetric applications typically encountered in feature film production. @@ -33,7 +33,7 @@ OpenVDB welcomes contributions to the OpenVDB project. Please refer to the [cont ### Developer Quick Start -The following provides basic installation examples for the core OpenVDB library. Other components, such as the python module, OpenVDB AX, NanoVDB and various executables, may require additional dependencies. See the [build documentation](https://academysoftwarefoundation.github.io/openvdb/build.html) for help with installations. +The following provides basic installation examples for the core OpenVDB library. Other components, such as the python module, OpenVDB AX, NanoVDB and various executables, may require additional dependencies. See the [build documentation](https://www.openvdb.org/documentation/doxygen/build.html) for help with installations. #### Linux ##### Installing Dependencies (Boost, TBB, Blosc) @@ -100,7 +100,7 @@ cmake --build . --parallel 4 --config Release --target install #### Building OpenVDB AX -OpenVDB AX depends on the core OpenVDB library. See the [build documentation](https://academysoftwarefoundation.github.io/openvdb/build.html) for all available AX component options: +OpenVDB AX depends on the core OpenVDB library. See the [build documentation](https://www.openvdb.org/documentation/doxygen/build.html) for all available AX component options: ```bash git clone git@github.com:AcademySoftwareFoundation/openvdb.git @@ -114,7 +114,7 @@ make -j4 && make install #### Building NanoVDB NanoVDB can be built with and without OpenVDB support. To see full build instructions -see the [NanoVDB build documentation](https://academysoftwarefoundation.github.io/openvdb/NanoVDB_HowToBuild.html) +see the [NanoVDB build documentation](https://www.openvdb.org/documentation/doxygen/NanoVDB_HowToBuild.html) #### Building Without OpenVDB Support diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 417a52b522..07798b3d36 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -41,6 +41,7 @@ set(DOXY_FILES openvdb/openvdb/io openvdb/openvdb/math openvdb/openvdb/points + openvdb/openvdb/points/impl openvdb/openvdb/python/pyopenvdb.h openvdb/openvdb/tools openvdb/openvdb/tree @@ -215,7 +216,6 @@ if(OPENVDB_DOXYGEN_AX) doc/ax/doc.txt openvdb_ax/openvdb_ax openvdb_ax/openvdb_ax/ast - openvdb_ax/openvdb_ax/cmd openvdb_ax/openvdb_ax/codegen openvdb_ax/openvdb_ax/compiler openvdb_ax/openvdb_ax/grammar @@ -235,9 +235,6 @@ if(OPENVDB_DOXYGEN_NANOVDB) doc/nanovdb/HelloWorld.md nanovdb/nanovdb nanovdb/nanovdb/util - nanovdb/nanovdb/cmd/convert - nanovdb/nanovdb/cmd/print - nanovdb/nanovdb/cmd/validate nanovdb/nanovdb/examples/benchmark nanovdb/nanovdb/examples/ex_bump_pool_buffer nanovdb/nanovdb/examples/ex_collide_level_set diff --git a/doc/ax/ax.txt b/doc/ax/ax.txt index 9487c64ff6..04ea616d43 100644 --- a/doc/ax/ax.txt +++ b/doc/ax/ax.txt @@ -1793,7 +1793,7 @@ returned, otherwise @b `c` is evaluated and returned. In this case, @b `a` and @ @anchor axvecmatinit @par Vector/Matrix Initializer @ref axvecmats "Vectors and matrices" can be represented as local variables (e.g. -@b `vec3f`), external attributes or parameters (e.g. @b `vec3f@attrib`) or as +@b `vec3f`), external attributes or parameters (e.g. @b `vec3f\@attrib`) or as temporary values using the vector/matrix initializer syntax. This operator has the form: @par diff --git a/doc/ax/axexamples.txt b/doc/ax/axexamples.txt index 9ea0aa79d0..c462950a42 100644 --- a/doc/ax/axexamples.txt +++ b/doc/ax/axexamples.txt @@ -32,7 +32,7 @@ These examples demonstrate how to use AX on OpenVDB points grids. Below is a small example which demonstrates working with a few point attributes. The @ symbol is the identifier for an AX attribute. The type of each attribute is specified before the @ symbol and the name is specified afterwards. For -example: @b `int@count` would imply an @b integer attribute called @b count. +example: @b `int\@count` would imply an @b integer attribute called @b count. @par In this example there are three point attributes: a @b float attribute @b speed, a @b vec3f float attribute @b velocity and a @b vec3f float attribute @b colour. @@ -114,7 +114,7 @@ v@P += v@v * dt; @endcode @par The final AX command, `v@P += v@v * dt;` writes to the position attribute of -the points @b `v@P`. Whenever position is written to in this way, the AX +the points @b `v\@P`. Whenever position is written to in this way, the AX `PointExecutable` will move (re-bucket) points in PointDataGrids. @subsection axexamplepointcurlnoise Curl Noise @@ -234,7 +234,7 @@ vec3f@vel += dt * massInverse * vec3f@force; @par Here we demonstrate how AX can be used to blend two volumes together. Note that only the volumes which are written to are executed over. In the below code, -only @b `@surface_a` is written to. This means that the final blended result, +only @b `\@surface_a` is written to. This means that the final blended result, stored in `surface_a`, will only be updated in `surface_a`'s topology. Should we want a combined blend of @b non @b overlapping areas of both surface a and b, we would need to activate a's topology with respect to b first. diff --git a/doc/changes.txt b/doc/changes.txt index 8bde58632d..3679e992a0 100644 --- a/doc/changes.txt +++ b/doc/changes.txt @@ -12,7 +12,7 @@ Bug Fixes: This could potentially be a problem on Windows debug builds (unconfirmed). - Minor fix to range in openvdb/tools/LevelSetSphere.h. This could result in data races for multi-threaded execution (unconfirmed) [Reported by Tommy Hinks] -- Fixed a bug with Tree::combineExtended which wouldn't propagate the resulting active state when a destination tile overlapped a source child node. [Reported by @frapit] +- Fixed a bug with Tree::combineExtended which wouldn't propagate the resulting active state when a destination tile overlapped a source child node. [Reported by \@frapit] - Fix unit tests failures with Blosc versions >= 1.19.0. @par @@ -56,7 +56,7 @@ preserve ABI compatibility it might be necessary to define the macro
Official release of NanoVDB, which for the first time offers GPU support for static sparse volumes in OpenVDB. See the -documentation +documentation for details.
@@ -488,7 +488,7 @@ a domain specific JIT (just-in-time) compiled expression language, providing users with a new way of interacting with OpenVDB data. AX is tailored towards writing highly parallelizable and customizable OpenVDB volume and point kernel operations. See the -documentation +documentation for more. @@ -768,7 +768,7 @@ Improvements: - Removed Boost::thread as a dependency of vdb_view in favour of std::thread. - Removed usage of boost/integer.hpp and boost/math/constants/constants.hpp, the latter in favour of new openvdb math constants for pi -- Removed usage of boost/mpl/*.hpp methods in favour of new template +- Removed usage of boost/mpl/\*.hpp methods in favour of new template meta-programming methods on the @vdblink::TypeList TypeList@endlink struct. This now supports get, front, back, contains, index, unique, popback, popfront and range removal of types. @@ -1234,7 +1234,7 @@ Bug fixes: @par API changes: - Moved the @vdblink::CopyConstness CopyConstness@endlink metafunction from - @link tree/TreeIterator.h TreeIterator.h@endlink to @link Types.h@endlink. + @link tree/TreeIterator.h TreeIterator.h@endlink to @link Types.h Types.h@endlink. @par Houdini: @@ -2199,8 +2199,8 @@ Bug fixes: - Fixed memory leak in a @vdblink::tools::meshToVolume tools::meshToVolume@endlink sub-tool (expandNarrowband). [Reported by Kévin Dietrich] -- Fixed parameter type inconsistencies in @link math/Stencils.h@endlink and - @link tools/RayIntersector.h@endlink. +- Fixed parameter type inconsistencies in @link math/Stencils.h math/Stencils.h@endlink + and @link tools/RayIntersector.h tools/RayIntersector.h@endlink. [Contributed by Kévin Dietrich and Nick Avramoussis] - Fixed a bug in the @vdblink::tools::VolumeToMesh VolumeToMesh@endlink tool that produced artifacts for adaptive surface extraction on clipped level sets. @@ -2514,7 +2514,7 @@ Houdini: for material color lookups. - Added @vdblink::getLibraryVersionString() getLibraryVersionString@endlink and - @link OPENVDB_LIBRARY_VERSION_STRING@endlink. + @link OPENVDB_LIBRARY_VERSION_STRING OPENVDB_LIBRARY_VERSION_STRING@endlink. - Modified the mesh to volume converter to always set the grid background value to the exterior narrow-band width, and added finite value checks to narrow band parameters. diff --git a/doc/nanovdb/doc.md b/doc/nanovdb/doc.md index 8d4567bdbd..6c935fe56e 100644 --- a/doc/nanovdb/doc.md +++ b/doc/nanovdb/doc.md @@ -2,7 +2,7 @@ Welcome to the NanoVDB documentation page. -* @ref NanoVDB_HowToBuild -* @ref NanoVDB_FAQ -* @ref NanoVDB_SourceTree -* @ref NanoVDB_HelloWorld \ No newline at end of file +* @subpage NanoVDB_HowToBuild +* @subpage NanoVDB_FAQ +* @subpage NanoVDB_SourceTree +* @subpage NanoVDB_HelloWorld diff --git a/nanovdb/nanovdb/util/Reduce.h b/nanovdb/nanovdb/util/Reduce.h index 43a22511be..7073d26e05 100644 --- a/nanovdb/nanovdb/util/Reduce.h +++ b/nanovdb/nanovdb/util/Reduce.h @@ -29,6 +29,7 @@ namespace nanovdb { /// @return reduction /// /// @param range RangeT can be Range, CoordBBox, tbb::blocked_range, blocked_range2D, or blocked_range3D. +/// @param identity initial value /// @param func functor with signature T FuncT::operator()(const RangeT& range, const T& a) const /// @param join functor with the signature T JoinT::operator()(const T& a, const T& b) const /// @code diff --git a/openvdb/openvdb/README b/openvdb/openvdb/README index 3eceb60367..f31787dd8c 100644 --- a/openvdb/openvdb/README +++ b/openvdb/openvdb/README @@ -9,7 +9,7 @@ volumetric data discretized on a three-dimensional grid. For instructions on library installation and dependencies see INSTALL For documentation of the library and code examples see: -https://academysoftwarefoundation.github.io/openvdb +https://www.openvdb.org/documentation/doxygen For more details visit the project's home page: www.openvdb.org diff --git a/openvdb/openvdb/points/PointMask.h b/openvdb/openvdb/points/PointMask.h index b06b7909f3..bd5b4ff44a 100644 --- a/openvdb/openvdb/points/PointMask.h +++ b/openvdb/openvdb/points/PointMask.h @@ -28,7 +28,7 @@ namespace OPENVDB_VERSION_NAME { namespace points { /// @brief Extract a Mask Tree from a Point Data Tree -/// @param grid the PointDataGrid to extract the mask from. +/// @param tree the PointDataTree to extract the mask from. /// @param filter an optional index filter /// @param threaded enable or disable threading (threading is enabled by default) template void getNode(NodeType*& node) const { mValueIterList.getNode(mLevel, node); } diff --git a/openvdb/openvdb/util/NullInterrupter.h b/openvdb/openvdb/util/NullInterrupter.h index e9ee417baf..2d04f18263 100644 --- a/openvdb/openvdb/util/NullInterrupter.h +++ b/openvdb/openvdb/util/NullInterrupter.h @@ -29,14 +29,14 @@ struct NullInterrupter virtual ~NullInterrupter() = default; /// Signal the start of an interruptible operation. /// @param name an optional descriptive name for the operation - virtual void start(const char* /*name*/ = nullptr) { } + virtual void start(const char* name = nullptr) { (void)name; } /// Signal the end of an interruptible operation. virtual void end() { } /// Check if an interruptible operation should be aborted. /// @param percent an optional (when >= 0) percentage indicating /// the fraction of the operation that has been completed /// @note this method is assumed to be thread-safe. - virtual bool wasInterrupted(int /*percent*/ = -1) { return false; } + virtual bool wasInterrupted(int percent = -1) { (void)percent; return false; } /// Convenience method to return a reference to the base class from a derived class. virtual NullInterrupter& interrupter() final { return static_cast(*this); diff --git a/openvdb_ax/openvdb_ax/compiler/PointExecutable.h b/openvdb_ax/openvdb_ax/compiler/PointExecutable.h index afa4bcc97f..525d4d1d1a 100644 --- a/openvdb_ax/openvdb_ax/compiler/PointExecutable.h +++ b/openvdb_ax/openvdb_ax/compiler/PointExecutable.h @@ -123,7 +123,7 @@ class OPENVDB_AX_API PointExecutable size_t getGrainSize() const; /// @brief Set attribute bindings. - /// @param attributeBindings A map of attribute bindings to expected names on + /// @param bindings A map of attribute bindings to expected names on /// the geometry to be executed over. By default the AX attributes will be /// bound to point attributes of the same name. Supplying bindings /// for a subset of the attributes will leave the others unchanged. diff --git a/openvdb_ax/openvdb_ax/compiler/VolumeExecutable.h b/openvdb_ax/openvdb_ax/compiler/VolumeExecutable.h index ca64a09f72..3d6e3ff768 100644 --- a/openvdb_ax/openvdb_ax/compiler/VolumeExecutable.h +++ b/openvdb_ax/openvdb_ax/compiler/VolumeExecutable.h @@ -247,7 +247,7 @@ class OPENVDB_AX_API VolumeExecutable [[deprecated]] Index getTreeExecutionLevel() const; /// @brief Set attribute bindings. - /// @param attributeBindings A map of attribute bindings to expected names on + /// @param bindings A map of attribute bindings to expected names on /// the geometry to be executed over. By default the AX attributes will be /// bound to volumes of the same name. Supplying bindings /// for a subset of the attributes will leave the others unchanged. diff --git a/openvdb_cmd/vdb_ax/main.cc b/openvdb_cmd/vdb_ax/main.cc index ff0163d346..541dae7926 100644 --- a/openvdb_cmd/vdb_ax/main.cc +++ b/openvdb_cmd/vdb_ax/main.cc @@ -151,7 +151,7 @@ auto usage_execute(const bool verbose) " " << gProgName << " points.vdb -s \"@P += v@v * 2;\" -o out.vdb // move points based on a vector attribute\n" << "\n" << " For more examples and help with syntax, see the AX documentation:\n" << - " https://academysoftwarefoundation.github.io/openvdb/openvdbax.html\n" << + " https://www.openvdb.org/documentation/openvdbax.html\n" << "\n"; } os << diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_AX.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_AX.cc index 3f1cdbaac4..92c147978e 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_AX.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_AX.cc @@ -422,7 +422,7 @@ vector@v2 = { 5.0f, 5.0f, 10.3f }; // Create a new float vector attribute using vec3i@vid = { 3, -1, 10 }; // Create a new integer vector attribute }}} -See the [ASWF OpenVDB AX documentation|https://academysoftwarefoundation.github.io/openvdb/openvdbax.html] for source code +See the [ASWF OpenVDB AX documentation|https://www.openvdb.org/documentation/openvdbax.html] for source code and usage examples. @vexsyntax VEX Hooks diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Analysis.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Analysis.cc index 1dcd275dd4..1f2a1a658b 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Analysis.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Analysis.cc @@ -149,7 +149,7 @@ Normalize (vector -> vector):\n\ "A VDB from the second input used to define the iteration space" " (see [specifying volumes|/model/volumes#group])\n\n" "The selected __Operator__ will be applied only where the mask VDB has" - " [active|https://academysoftwarefoundation.github.io/openvdb/overview.html#subsecInactive]" + " [active|https://www.openvdb.org/documentation/doxygen/overview.html#subsecInactive]" " voxels or, if the mask VDB is a level set, only in the interior of the level set.")); // Output name diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Densify.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Densify.cc index e93b0f7472..12749b86dc 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Densify.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Densify.cc @@ -61,8 +61,8 @@ newSopOperator(OP_OperatorTable* table) @overview\n\ \n\ This node replaces active\n\ -[tiles|https://academysoftwarefoundation.github.io/openvdb/overview.html#secSparsity]\n\ -in VDB [trees|https://academysoftwarefoundation.github.io/openvdb/overview.html#secTree]\n\ +[tiles|https://www.openvdb.org/documentation/doxygen/overview.html#secSparsity]\n\ +in VDB [trees|https://www.openvdb.org/documentation/doxygen/overview.html#secTree]\n\ with dense, leaf-level voxels.\n\ This is useful for subsequent processing with nodes like [Node:sop/volumevop]\n\ that operate only on leaf voxels.\n\ diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Fill.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Fill.cc index dfe1f5475b..58f09c1d35 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Fill.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Fill.cc @@ -84,10 +84,10 @@ newSopOperator(OP_OperatorTable* table) "How to specify the bounding box to be filled\n\n" "Index Space:\n" " Interpret the given min and max coordinates in" -" [index-space|https://academysoftwarefoundation.github.io/openvdb/overview.html#subsecVoxSpace] units.\n" +" [index-space|https://www.openvdb.org/documentation/doxygen/overview.html#subsecVoxSpace] units.\n" "World Space:\n" " Interpret the given min and max coordinates in" -" [world-space|https://academysoftwarefoundation.github.io/openvdb/overview.html#subsecWorSpace] units.\n" +" [world-space|https://www.openvdb.org/documentation/doxygen/overview.html#subsecWorSpace] units.\n" "Reference Geometry:\n" " Use the world-space bounds of the reference input geometry.\n")); diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Metadata.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Metadata.cc index ed8f7f66aa..c41ebd7e52 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Metadata.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Metadata.cc @@ -156,10 +156,10 @@ Other:\n\ @overview\n\ \n\ This node allows one to create and edit\n\ -[metadata|https://academysoftwarefoundation.github.io/openvdb/codeExamples.html#sHandlingMetadata]\n\ +[metadata|https://www.openvdb.org/documentation/doxygen/codeExamples.html#sHandlingMetadata]\n\ attached to a VDB volume.\n\ Some standard VDB metadata, such as the\n\ -[grid class|https://academysoftwarefoundation.github.io/openvdb/overview.html#secGrid],\n\ +[grid class|https://www.openvdb.org/documentation/doxygen/overview.html#secGrid],\n\ is exposed via intrinsic attributes on the primitive and can be viewed\n\ and in some cases edited either from the [geometry spreadsheet|/ref/panes/geosheet]\n\ or with the [Node:sop/attribcreate] node, but changes to attribute values\n\ diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Points_Convert.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Points_Convert.cc index 7f865c1606..e02744e5aa 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Points_Convert.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Points_Convert.cc @@ -447,7 +447,7 @@ Unit Vector:\n\ @overview\n\ \n\ This node converts an unstructured cloud of points to and from a single\n\ -[VDB Points|https://academysoftwarefoundation.github.io/openvdb/points.html] primitive.\n\ +[VDB Points|https://www.openvdb.org/documentation/doxygen/points.html] primitive.\n\ The resulting primitive will reorder the points to place spatially\n\ close points close together.\n\ It is then able to efficiently unpack regions of interest within that primitive.\n\ diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Prune.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Prune.cc index 0baddf89fe..86f93d407b 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Prune.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Prune.cc @@ -94,7 +94,7 @@ newSopOperator(OP_OperatorTable* table) @overview\n\ \n\ This node prunes branches of VDB\n\ -[trees|https://academysoftwarefoundation.github.io/openvdb/overview.html#secTree]\n\ +[trees|https://www.openvdb.org/documentation/doxygen/overview.html#secTree]\n\ where all voxels have the same or similar values.\n\ This can help to reduce the memory footprint of a VDB, without changing its topology.\n\ With a suitably high tolerance, pruning can function as a simple\n\ diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Resample.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Resample.cc index 9123aa4e1f..7fb20c5d0a 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Resample.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Resample.cc @@ -208,7 +208,7 @@ Using Voxel Scale Only:\n\ .setTooltip( "Apply the resampling transform to the voxel values of vector-valued VDBs," " in accordance with those VDBs'" - " [Vector Type|https://academysoftwarefoundation.github.io/openvdb/overview.html#secGrid]" + " [Vector Type|https://www.openvdb.org/documentation/doxygen/overview.html#secGrid]" " attributes.")); // Level set rebuild toggle diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Scatter.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Scatter.cc index 5accbd1adf..fc08051205 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Scatter.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Scatter.cc @@ -237,7 +237,7 @@ with the same transform and topology as the source.\n\ For signed distance field or fog volume VDBs, points can be scattered\n\ either throughout the interior of the volume or only on an isosurface.\n\ For level sets, an additional option is to scatter points only in the\n\ -[narrow band|https://academysoftwarefoundation.github.io/openvdb/overview.html#secGrid]\n\ +[narrow band|https://www.openvdb.org/documentation/doxygen/overview.html#secGrid]\n\ surrounding the zero crossing.\n\ For all other volumes, points are scattered in active voxels.\n\ \n\ diff --git a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Visualize.cc b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Visualize.cc index 2caaa49b94..501b08225b 100644 --- a/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Visualize.cc +++ b/openvdb_houdini/openvdb_houdini/SOP_OpenVDB_Visualize.cc @@ -150,7 +150,7 @@ newSopOperator(OP_OperatorTable* table) "Specify whether to draw the camera frustums\n" "of VDBs with frustum transforms.") .setDocumentation( - "For VDBs with [frustum transforms|https://academysoftwarefoundation.github.io/openvdb/" + "For VDBs with [frustum transforms|https://www.openvdb.org/documentation/doxygen/" "transformsAndMaps.html#sFrustumTransforms]," " generate geometry representing the frustum bounding box.")); @@ -228,7 +228,7 @@ newSopOperator(OP_OperatorTable* table) .setDocumentation( "For voxels, tiles, and leaf nodes rendered as points, add an attribute to" " the points that gives the coordinates of the points in the VDB's [index space|" - "https://academysoftwarefoundation.github.io/openvdb/overview.html#secSpaceAndTrans].")); + "https://www.openvdb.org/documentation/doxygen/overview.html#secSpaceAndTrans].")); parms.add(hutil::ParmFactory(PRM_TOGGLE, "addvalue", "Points with Values") .setTooltip("Add a voxel/tile value attribute to points.") @@ -418,14 +418,14 @@ newSopOperator(OP_OperatorTable* table) #tags: vdb\n\ \n\ \"\"\"Generate geometry to visualize the internal\n\ -[tree structure|https://academysoftwarefoundation.github.io/openvdb/overview.html#secTree]\n\ +[tree structure|https://www.openvdb.org/documentation/doxygen/overview.html#secTree]\n\ of a VDB volume.\"\"\"\n\ \n\ @overview\n\ \n\ This node can be a useful troubleshooting tool.\n\ Among other things, it allows one to evaluate the\n\ -[sparseness|https://academysoftwarefoundation.github.io/openvdb/overview.html#secSparsity]\n\ +[sparseness|https://www.openvdb.org/documentation/doxygen/overview.html#secSparsity]\n\ of VDB volumes as well as to examine their extents and the values of individual voxels.\n\ \n\ @related\n\ diff --git a/tsc/process/release.md b/tsc/process/release.md index 00f9d876dd..db8ecda155 100644 --- a/tsc/process/release.md +++ b/tsc/process/release.md @@ -9,7 +9,7 @@ The following assumes that the current OpenVDB library version number is 6.0.0 a * 2a. Create a new `v6.1.0` tag under the "Choose a tag" drop-down (Note that this tag will not be created until the release is published). * 2b. Select `v6.1.0_rc` under the "Target" drop-down. * 2c. Set "OpenVDB 6.1.0" as the title. - * 2d. As a minimum, the body should be "See the [release notes](https://academysoftwarefoundation.github.io/openvdb/changes.html#v6_1_0_changes) for more details.". Include the correct link to the documentation. (Note this link will be broken until the documentation is generated in step 8). It is optional to also include a few release highlights. + * 2d. As a minimum, the body should be "See the [release notes](https://www.openvdb.org/documentation/doxygen/changes.html#v6_1_0_changes) for more details.". Include the correct link to the documentation. (Note this link will be broken until the documentation is generated in step 8). It is optional to also include a few release highlights. * 2e. Click the "Save draft" button. DO NOT publish the release at this stage. 3. Check out the `v6.1.0_rc` branch. 4. Ensure the root `CMakeLists.txt` has the correct version number at the top. @@ -17,7 +17,7 @@ The following assumes that the current OpenVDB library version number is 6.0.0 a 6. Update the "Version 6.1.0 - In development" section in `CHANGES` and `doc/changes.txt` to replace "In development" with the planned release date. 7. Merge these changes to `v6.1.0_rc` in a new pull request and verify that the build CI runs successfully. 8. Manually dispatch the weekly CI workflow from the `v6.1.0_rc` branch and verify that the additional checks run successfully. -9. Go to the [GitHub docs actions](https://github.com/AcademySoftwareFoundation/openvdb/actions/workflows/docs.yml?query=workflow%3ADocs) for OpenVDB and manually dispatch the workflow for the `v6.1.0_rc` branch and set deploy to "true". This will deploy the documentation and typically takes around 15 mins. When the action completes, [check over the documentation](https://academysoftwarefoundation.github.io/openvdb/). Fix any errors through pull request and re-dispatch the workflow if necessary. +9. Go to the [GitHub docs actions](https://github.com/AcademySoftwareFoundation/openvdb/actions/workflows/docs.yml?query=workflow%3ADocs) for OpenVDB and manually dispatch the workflow for the `v6.1.0_rc` branch and set deploy to "true". This will deploy the documentation and typically takes around 15 mins. When the action completes, [check over the documentation](https://www.openvdb.org/documentation/doxygen/). Fix any errors through pull request and re-dispatch the workflow if necessary. 10. Confirm that the release notes link in the draft release now points at the correct release notes. 12. Publish the GitHub draft release from the [GitHub releases](https://github.com/AcademySoftwareFoundation/openvdb/releases) page. 13. Merge the `v6.1.0_rc` branch back into `master` in a new pull request to ensure edits to release notes or any other fixes go back to master.