Commit Graph

45 Commits

Author SHA1 Message Date
barry
707e585ea2 Added new documentation pages for Metal examples:
- added new RST pages and images for the mtlViewer and mtlPtexViewer
    - added new table to the main Code Examples page for the Metal examples
2019-06-20 11:40:28 -07:00
barry
0245184e11 Updated documentation for 3.4 release notes and past release dates:
- added new page and images for 3.4 release notes
    - updated Release Notes page with dates for all past releases
2019-06-10 16:33:41 -07:00
barry
e8d226335f Removed source files for obsolete documentation pages 2019-04-01 10:47:55 -07:00
barry
7aff9287d8 Reorganized Far tutorials into groups:
- moved and renumbered the 11 Far tutorials into 5 groups
    - updated documentation/tutorials.rst:
        - replaced the two-column tables with simple sections
        - created sub-sections describing the Far tutorial groups
    - updated additional Far tutorial references for new numbering
2019-03-21 18:43:02 -07:00
barry
6cae3a8e6d Additions and minor improvements to far/tutorials:
- added far/tutorial_10 illustrating variable width vertex class
    - revised far/tutorial_9 for command line and documentation conventions
    - updated doc/tutorials.rst with missing and new tutorial descriptions
2019-02-13 11:37:41 -08:00
David G Yu
195111a8e1 Release 3.3.0 2017-07-25 13:58:09 -07:00
David G Yu
62e1a62842 Release 3.2.0 2017-01-31 13:43:21 -08:00
David G Yu
3957da8e9c Reorganized release specific documentation
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.
2016-10-13 17:38:08 -07:00
David G Yu
c7c55ac4d2 Removed roadmap page from the documentation.
The roadmap presented was significantly out of date.
We will find a better way to document work in progress.
2016-10-13 15:28:05 -07:00
David G Yu
f05e01c921 Removed remaining doc for mayaPolySmooth example 2016-10-13 09:28:23 -07:00
George ElKoura
d856975ef3 No longer use CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR
As mentioned in issue #814, avoiding the use of CMAKE_SOURCE_DIR makes it easier to integrate OpenSubdiv as a submodule in other projects.

Fixes #814.
2016-07-08 22:45:33 -07:00
George ElKoura
87a7fd831c Added references section to the documentation
- 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.
2015-07-13 18:13:54 -07:00
jcowles
7f8fc77cfc Added "contributing" doc + minor doc cleanup
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"
2015-06-22 16:12:55 -07:00
George ElKoura
a85a807e71 Moved the Hbr and Hierarchical Edits documents
The Hbr and Hierarchical Edits documents are now clearly marked in a
deprecated section.
2015-06-20 13:20:46 -07:00
Takahito Tejima
87d35ea886 fix document build 2015-06-18 16:40:27 -07:00
George ElKoura
a51456963c Reorganized Release Notes
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.
2015-06-17 20:19:14 -07:00
Takahito Tejima
4f2c33bf08 update osd layer documents
- the first pass of revised Osd overview
- add a new doc for osd shader interface.
- update the api layers diagram.
2015-06-17 17:26:09 -07:00
George ElKoura
40c5dbdd82 Split out Compatiblity Guide into a separate page.
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.
2015-06-15 20:16:47 -07:00
jcowles
62681bf791 Added porting guide to public documentation
This document is a work in progress with some sections left incomplete for other
developers to fill in.
2015-06-09 13:21:03 -07:00
manuelk
2697c31eed Add WIP downloads / EULA documentation page 2015-02-27 16:09:17 -08:00
manuelk
99843dc650 Adding modeling tips to ReST documentation 2015-01-14 18:11:10 -08:00
manuelk
9b3f25df2c Adding git URL to html tutorial documentation 2014-12-01 18:49:51 -08:00
manuelk
a8ee36ae33 Add automatic ReST pages to the documentation for the tutorials code
- add python script to generate ReST from the C++ tutorial source files
- add css stylesheet for C++ syntax highlighting (based on my nedit settings)
- add functionality to CMake build to make it all happen
- add hyperlinks to tutorials.rst file
2014-12-01 15:52:58 -08:00
manuelk
c6306b42c4 Documenation update
- add licensing information page
- add roadmap page
- minor tweaks to intro page
- small fix to navigation bar css
2014-11-13 13:57:34 -08:00
manuelk
ac34609420 Reformatting navigation bar in ReST documentation to add Github button 2014-10-27 14:31:04 -07:00
manuelk
c399655dcc Landing 3.0.0.alpha
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.
2014-09-05 15:07:46 -07:00
mkraemer
05a7db5e14 Make CMake path variables more robust
Add quotes around variables containing paths - this might require a second pass...

fixes #258
2014-04-09 16:43:38 -04:00
manuelk
b3b2e56a26 Adding recommended isolation output to OsdPolySmooth node.
- added attribute to the maya example node
- added AE template for editor display
- added ReSt documentation for the plugin
2013-11-25 17:12:57 -08:00
manuelk
6eb4bdf87b Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00
manuelk
3ae50d1c50 Amending Apache license language & file headers.
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.
2013-09-26 12:04:57 -07:00
David Aguilar
55c0b0d70f Install documentation into share/doc/opensubdiv/
Per the Filesystem Hierarchy Standard:

http://www.pathname.com/fhs/pub/fhs-2.3.html#SPECIFICOPTIONS15
2013-09-16 18:40:17 -07:00
Manuel Kraemer
cf847df9e8 Adding external documentation links
Adding a page to link to videos, tutorials, blogs...
2013-09-14 08:34:27 -07:00
manuelk
7d4999c46e Adding support for subdivision stencils.
- 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
2013-09-11 16:05:14 -07:00
manuelk
94fc47a9db adding Osd documentation based on Siggraph slides
fixes #138
2013-07-29 19:14:19 -07:00
Takahito Tejima
51a45b598d Updating EULA 2013-07-18 14:19:50 -07:00
manuelk
71d55db586 adding reST documentation content 2013-07-18 09:01:51 -07:00
manuelk
f079e57f96 Fix doc build
- turn the _add_doxy_headers macro into a no-op if -DNO_DOC is used
  so it doesn't cause problems

- moved the -DNO_DOC conditional into the top CMakeLists file, following
  pattern with other override flags
2013-07-09 10:00:40 -07:00
Manuel Kraemer
bf378b16a5 Intermediate documentation check-in
- changes to the documentation build
- added content & images
- style changes
2013-07-07 18:20:46 -07:00
manuelk
a0ba18a6d6 intermediate documentation check-in : adding content 2013-07-05 18:41:04 -07:00
manuelk
9712b44239 Documentation build modifications:
- 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
2013-07-05 15:36:54 -07:00
Manuel Kraemer
7a71def44a Adding more documentation
- 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
2013-07-04 19:17:34 -07:00
manuelk
e3109ae507 Incremental commit for the new HTML documentation system:
- 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
2013-07-04 10:47:56 -07:00
manuelk
b815aff333 First pass at fixing the installation part of the Cmake build : now CMAKE_INSTALL_PREFIX can
be used as intended to specify an installation directory, which can be located anywhere on the
file system.

Also improved the doxygen target and made the doxy build "quiet".

fixes #154
2013-04-22 19:35:41 -07:00
manuelk
7c10b9c321 minor cleanup of doxygen cmake rules 2013-02-08 14:32:01 -08:00
Manuel Kraemer
7fd99b421f Taking a first stab at a doxygen config file and matching cmake rules.
Also reformatting a chunk of FAR's comments to work w/ doxygen.

Closes #75
2012-10-06 17:53:51 -07:00