With our second substantial release in the 3.x series
we've reorganized the documentation links a bit. This
establishes a more consistent arrangement for release
specific documentation pages.
- Added new references section for folks wishing to learn more about
subdivision.
- Fixed a reference in the intro.
- Fixed a minor typo in the nav bar.
This is a good start, but more could be done to make it even more useful for
developers.
* Updated nav_template to include contributing
* Removed contributing from intro
* Fixed RST compiler error in hedits
* Renamed "OpenSubdiv" header in nav to "OpenSubdiv User Guide"
Having two introduction sections in the navigation bar was awkward, here I've
left "introduction" as-is but changed "Introduction to 3.0" to "Release 3.0" and
"Release 3.0" to "Overview".
This updates much of the initial overview documentation
to make a clearer distinction between topology refinement
and primvar refinement and describes the different classes
and methods that are used.
Hierarchical Edits have been deprecated in OSD 3.0, so
remove the documentation for them from the main pages.
I put the extracted docs in a file rather than deleting
them in case we want to refer to them later easily.
Removed the link to the 'Textures' document because it is incomplete.
Still keep the texture document (in the tree and in the CMakeLists.txt to one day revive.
Modified Release Notes to be a brief overview of the 3.0 release
features, while moving the descriptive text to a new section that
outlines the major changes in 3.0 grouped along with the Porting
Guide and Subdivision Compatibility document.
The compatibility portions of the "Porting Guide" are
now split into a different page. We'd like to keep
the "Porting Guide" simple and easy to understand.
The Compatiblity portion may live on longer than what
is just needed for Porting from 2.x to 3.0.
Sync'ing the 'dev' branch with the 'feature_3.0dev' branch at commit 68c6d11fc36761ae1a5e6cdc3457be16f2e9704a
The branch 'feature_3.0dev' is now locked and preserved for historical purposes.
New text:
Copyright 2013 Pixar
Licensed under the Apache License, Version 2.0 (the "Apache License")
with the following modification; you may not use this file except in
compliance with the Apache License and the following modification to it:
Section 6. Trademarks. is deleted and replaced with:
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor
and its affiliates, except as required to comply with Section 4(c) of
the License and to reproduce the content of the NOTICE file.
You may obtain a copy of the Apache License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the Apache License with the above modification is
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the Apache License for the specific
language governing permissions and limitations under the Apache License.
- Adding FarStencilTables and FarStencilTablesFactory classes
- Adding Osd EvalStencil context & controllers for CPU, OMP and TBB backends
- Adding the code example glStencilViewer
- Adding reST documentation
- Changing version to 2.2.0_dev
- Fix HbrMesh::Unrefine function
- Fix "CanEval" function in OsdVertexBufferDescriptor
Note 0: there is no stencil support for hierarchical edits
Note 1: there is no support for face-varying data stencils yet
Note 2: the current stencil factory is lazy but the caching system is not re-entrant
- add macro "_add_doxy_headers" in order to track all header files elligible for
doxygen documenation. This captures public header files that would otherwise be
excluded from installation because they are not supported by the OS. Private
header files remain excluded though.
- add custom targets and commands so that documentation build produces functioning
RST and Doxygen documentation both in the build and install stages
- switched to Doxygen 1.8 (because markdown will make in-lined documentation easier)
- added build switches to disable examples, regression and python-SWIG targets
- fixed doxygen link in the nav bar
- modified python html processing tool to match Cmake changes
- new RST pages for our excample code
- fix doxygen documentation link from the nav tab
- fix cmake build rules (still not quite working as intended)
- adding API RST documentation all around
- adding docutils cmake module
- adding rst2html conversion build step to our documentation folder
- adding tipue search system
- adding a python script to insert HTML navigation template and index HTML documentation contents
- adding RST documentation content, images and temporary CSS styling
