OpenSubdiv/documentation
David G Yu cb1657be17 Implemented alternate Python 'stringify' tool
This simplifies build dependencies when cross-compiling
or when building multi-architecture binaries.

For backward compatibility with earlier releases, the compiled
C++ version of this tool is used when no Python interpreter is found.
2022-09-12 17:19:27 -07:00
..
css Updated logo and header icons 2015-06-23 09:57:12 -07:00
images Addition of Bfr interface (4 of 4): documentation 2022-08-02 20:41:55 -07:00
tipuesearch Applying OpenSubdiv site template to docs. 2013-07-18 11:26:54 -07:00
additional_resources.rst Updated video links 2021-07-28 12:42:56 -07:00
api_overview.rst Addition of Bfr interface (4 of 4): documentation 2022-08-02 20:41:55 -07:00
bfr_overview.rst Addition of Bfr interface (4 of 4): documentation 2022-08-02 20:41:55 -07:00
cmake_build.rst Updated CMake minimum version to 3.12 2022-09-09 09:11:37 -07:00
CMakeLists.txt Implemented alternate Python 'stringify' tool 2022-09-12 17:19:27 -07:00
code_examples.rst Added new documentation pages for Metal examples: 2019-06-20 11:40:28 -07:00
compatibility.rst Modified section titles and internal targets to preserve external links: 2019-04-11 20:25:31 -07:00
contributing.rst Updated for rename of 'master' branch to 'release' 2021-02-04 10:09:42 -08:00
diagrams.odg update boundary interpolation diagram. 2015-06-23 09:27:10 -07:00
downloads.rst Add WIP downloads / EULA documentation page 2015-02-27 16:09:17 -08:00
dxptexviewer.rst Minor improvements to documentation pages for DirectX examples: 2019-06-20 11:43:57 -07:00
dxviewer.rst Minor improvements to documentation pages for DirectX examples: 2019-06-20 11:43:57 -07:00
examples_see_also.rst Updated documentation for the example applications: 2019-04-01 10:15:33 -07:00
far_overview.rst Revised documentation for Far overview to include existing ptex images: 2019-06-27 13:53:57 -07:00
getting_started.rst Updated for rename of 'master' branch to 'release' 2021-02-04 10:09:42 -08:00
glevallimit.rst Updated GL examples for common command line arguments: 2019-04-24 19:39:18 -07:00
glfvarviewer.rst Updated documentation for the example applications: 2019-04-01 10:15:33 -07:00
glpainttest.rst Updated GL examples for common command line arguments: 2019-04-24 19:39:18 -07:00
glptexviewer.rst Updated GL examples for common command line arguments: 2019-04-24 19:39:18 -07:00
glsharetopology.rst Updated documentation for the example applications: 2019-04-01 10:15:33 -07:00
glstencilviewer.rst Updated GL examples for common command line arguments: 2019-04-24 19:39:18 -07:00
glviewer.rst Replaced -axis with -yup in common args and examples: 2019-04-16 18:59:24 -07:00
hbr_overview.rst Modified section titles and internal targets to preserve external links: 2019-04-11 20:25:31 -07:00
hedits.rst Added "contributing" doc + minor doc cleanup 2015-06-22 16:12:55 -07:00
intro.rst Updated intro splash image 2019-06-28 11:51:21 -07:00
license.rst Documenation update 2014-11-13 13:57:34 -08:00
mod_notes.rst Updated video links 2021-07-28 12:42:56 -07:00
mtlptexviewer.rst Updated more examples images and docs 2019-06-24 12:42:11 -07:00
mtlviewer.rst Updated more examples images and docs 2019-06-24 12:42:11 -07:00
nav_template.txt Addition of Bfr interface (4 of 4): documentation 2022-08-02 20:41:55 -07:00
OpenSubdiv.doxy Addition of Bfr interface (4 of 4): documentation 2022-08-02 20:41:55 -07:00
osd_overview.rst Updated Far and Osd user guide docs for 3.4 2019-06-24 18:43:05 -07:00
osd_shader_interface.rst Updated Far and Osd user guide docs for 3.4 2019-06-24 18:43:05 -07:00
porting.rst Modified section titles and internal targets to preserve external links: 2019-04-11 20:25:31 -07:00
processHtml.py Updated doc build scripts for Python 3 2022-09-11 15:33:46 -07:00
processTutorials.py Updated doc build scripts for Python 3 2022-09-11 15:33:46 -07:00
README Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
references.rst Fixed author attribution for Loop 2008 AAC paper 2015-08-03 10:40:54 -07:00
release_30.rst Reorganized release specific documentation 2016-10-13 17:38:08 -07:00
release_31.rst Modified section titles and internal targets to preserve external links: 2019-04-11 20:25:31 -07:00
release_32.rst Release 3.2.0 2017-01-31 13:43:21 -08:00
release_33.rst Release 3.3.0 2017-07-25 13:58:09 -07:00
release_34.rst Addition of Bfr interface (4 of 4): documentation 2022-08-02 20:41:55 -07:00
release_notes_2x.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
release_notes.rst Release 3.4.4 2021-02-05 17:24:39 -08:00
rst_template.txt Updated doc template to link to terms of use 2017-07-13 17:18:42 -07:00
sdc_overview.rst Added some minor grammar and spelling fixes 2015-06-22 20:24:43 -07:00
search.html Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
subdivision_surfaces.rst Updated documentation related to boundary interpolation case "none": 2020-01-10 14:26:51 -08:00
tutorials.rst Additions and improvements to Bfr tutorials: 2022-08-25 17:20:21 -07:00
under_development.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
using_osd_hbr.rst Modified section titles and internal targets to preserve external links: 2019-04-11 20:25:31 -07:00
vtr_overview.rst update overviews: remove tiny api_layer images 2015-06-22 17:37:41 -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