OpenSubdiv/documentation
David G Yu 248ebcaabc Merge pull request #684 from c64kernal/dev_doxtwk
More small tweaks to the docs.
2015-06-22 20:32:53 -07:00
..
css Fix documentation code highlighing 2014-12-04 11:30:22 -08:00
images updating diagrams. make backgrounds transparent. 2015-06-22 20:06:47 -07:00
tipuesearch Applying OpenSubdiv site template to docs. 2013-07-18 11:26:54 -07:00
additional_resources.rst Fix URL in documentation 2014-12-01 16:48:25 -08:00
api_overview.rst minor update in api_overview: add some links to deeper sections. 2015-06-22 17:37:41 -07:00
cmake_build.rst More small tweaks to the docs. 2015-06-22 19:53:52 -07:00
CMakeLists.txt Added "contributing" doc + minor doc cleanup 2015-06-22 16:12:55 -07:00
code_examples.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
compatibility.rst Minor tweaks to the compatibility page. 2015-06-22 19:22:22 -07:00
contributing.rst More small tweaks to the docs. 2015-06-22 19:53:52 -07:00
diagrams.odg updating diagrams. make backgrounds transparent. 2015-06-22 20:06:47 -07:00
downloads.rst Add WIP downloads / EULA documentation page 2015-02-27 16:09:17 -08:00
dxptexviewer.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
dxviewer.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
examples_see_also.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
far_overview.rst Some more updates to the far_overview 2015-06-22 18:30:42 -07:00
getting_started.rst Merge pull request #684 from c64kernal/dev_doxtwk 2015-06-22 20:32:53 -07:00
glbatchviewer.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
glevallimit.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
glfvarviewer.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
glpainttest.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
glptexviewer.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
glsharetopology.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
glstencilviewer.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
glviewer.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
hbr_overview.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
hedits.rst Added "contributing" doc + minor doc cleanup 2015-06-22 16:12:55 -07:00
intro_30.rst Minor overview doc changes and nav title update 2015-06-22 13:32:34 -07:00
intro.rst Added "contributing" doc + minor doc cleanup 2015-06-22 16:12:55 -07:00
license.rst Documenation update 2014-11-13 13:57:34 -08:00
maya_osdpolysmooth.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
mod_notes.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
nav_template.txt Added "contributing" doc + minor doc cleanup 2015-06-22 16:12:55 -07:00
OpenSubdiv.doxy WIP doxyfication of Sdc 2014-12-22 11:29:15 -08:00
osd_overview.rst update overviews: remove tiny api_layer images 2015-06-22 17:37:41 -07:00
osd_shader_interface.rst Minor typo fixing and editing for osd_shader_interface. 2015-06-21 18:48:04 -07:00
porting.rst Further editing down of Porting Guide. 2015-06-21 18:13:23 -07:00
processHtml.py Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
processTutorials.py Adding git URL to html tutorial documentation 2014-12-01 18:49:51 -08:00
README Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
release_notes_2x.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
release_notes.rst Updates to 3.0 Intro and Release Notes docs 2015-06-18 21:04:00 -07:00
roadmap.rst Fixed references to Osd::DrawContext/Controller 2015-06-17 15:58:18 -07:00
rst_template.txt Add automatic ReST pages to the documentation for the tutorials code 2014-12-01 15:52:58 -08:00
sdc_overview.rst update overviews: remove tiny api_layer images 2015-06-22 17:37:41 -07:00
search.html Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
subdivision_surfaces.rst updating diagrams. make backgrounds transparent. 2015-06-22 20:06:47 -07:00
tutorials.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
under_development.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
using_osd_hbr.rst Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
using_osd_textures.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
using_osd.rst update doc: flip the order of API layers. sdc > vtr > far > osd. 2015-06-18 15:11:04 -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