OpenSubdiv/documentation
Sergey Sharybin 6ef232c95a Integrate CLEW into osd library and examples
If the system has CLEW installed (which is detected by recently
added FindCLEW routines) then OpenSubduv would be compiled against
this library.

It makes binaries and libraries more portable across the systems,
so it's possible to run the same binary on systems with and without
OpenCL SDK installed.

The most annoying part of the change is updating examples to load
OpenCL libraries, but ideally code around controllers and interface
creation is to be de-duplicated anyway.

Based on the pull request #303 from Martijn Berger
2014-05-22 09:10:59 +02:00
..
css Addding some video links to our collection of external resources. 2013-10-28 10:10:03 -07:00
images Adding documentation (face-varying boundary interpolation rules) 2014-02-25 17:08:22 -08:00
tipuesearch Applying OpenSubdiv site template to docs. 2013-07-18 11:26:54 -07:00
additional_resources.rst Addding some video links to our collection of external resources. 2013-10-28 10:10:03 -07:00
api_overview.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
cmake_build.rst Integrate CLEW into osd library and examples 2014-05-22 09:10:59 +02:00
CMakeLists.txt Make CMake path variables more robust 2014-04-09 16:43:38 -04:00
code_examples.rst Adding recommended isolation output to OsdPolySmooth node. 2013-11-25 17:12:57 -08:00
diagrams.odg Correct vertex boundary interpolation rules doc 2013-09-20 10:49:50 -07:00
dxviewer.rst Update dxViewer example documentation 2014-04-14 12:08:59 -07:00
far_overview.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
getting_started.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
glbatchviewer.rst Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00
glstencilviewer.rst Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00
glviewer.rst Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00
hbr_overview.rst Adding documentation (boundary interpolation rules) 2014-02-25 15:27:12 -08:00
intro.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
limiteval.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
maya_osdpolysmooth.rst Adding recommended isolation output to OsdPolySmooth node. 2013-11-25 17:12:57 -08:00
nav_template.txt Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
OpenSubdiv.doxy Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
osd_overview.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
painttest.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
processHtml.py Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
ptexviewer.rst Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00
README Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
release_notes.rst Update release notes for release 2.4.1 2014-04-21 12:18:16 -07:00
rst_template.txt Changing OS main site links to be absolute, not relative 2013-07-18 14:29:06 -07:00
search.html Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
subdivision_surfaces.rst Adding documentation content 2014-04-09 11:20:59 -04:00
using_osd_compile.rst Add a note in the documentation about disabling offsetof warning. 2013-09-27 10:53:56 -07:00
using_osd_hbr.rst Adding documentation (boundary interpolation rules) 2014-02-25 15:27:12 -08:00
using_osd_textures.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
using_osd.rst Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
uvviewer.rst Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00

     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.


ReST Documentation
==================



    Editing the navigation tab
    --------------------------
    
    Edit the file 'nav_template.txt'. It is injected by the python script
    'processHtml.py' in the HTML generated by rst2html (docutils).
    
    Note: html comments will be stripped (removes the license text)



    Inserting content in <head>
    ---------------------------
    
    Edit the file 'rst_template.txt' and add HTML in the %(head) section (see 
    the "favicon" link for reference). Other sections can be similarly accessed.
    

    Diagrams
    --------
    
    Use diagrams.odg in OpenOfficeDraw to edit the new diagrams. Use the export
    function to generate bitmaps in the images/ directory.


    Styling
    -------
    
    The css sheet is in css/rst.css

Doxygen Documentation
=====================

    Styling
    -------
    
    The css sheet is in css/doxy.css