OpenSubdiv/documentation
2013-08-01 16:14:23 -07:00
..
css Updating EULA 2013-07-18 15:05:24 -07:00
images adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
tipuesearch Applying OpenSubdiv site template to docs. 2013-07-18 11:26:54 -07:00
api_overview.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
cmake_build.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
CMakeLists.txt adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
code_examples.rst Updating EULA 2013-07-18 15:05:24 -07:00
diagrams.odg adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
dxviewer.rst Updating EULA 2013-07-18 15:05:24 -07:00
far_overview.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
getting_started.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
glbatchviewer.rst Updating EULA 2013-07-18 15:05:24 -07:00
glviewer.rst Updating EULA 2013-07-18 15:05:24 -07:00
hbr_overview.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
intro.rst update documentation & CLA files to reflect Apache 2.0 move 2013-08-01 16:14:23 -07:00
limiteval.rst Updating EULA 2013-07-18 15:05:24 -07:00
nav_template.txt adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
OpenSubdiv.doxy - fixing comments in Far for better Doxygen readability 2013-07-10 18:51:43 -07:00
osd_overview.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
painttest.rst Updating EULA 2013-07-18 15:05:24 -07:00
processHtml.py Updating EULA 2013-07-18 15:05:24 -07:00
ptexviewer.rst Updating EULA 2013-07-18 15:05:24 -07:00
README Updating EULA 2013-07-18 15:11:47 -07:00
release_notes.rst Updating release notes 2013-07-18 15:43: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 Updating EULA 2013-07-18 15:05:24 -07:00
subdivision_surfaces.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
using_osd_compile.rst Updating EULA 2013-07-18 15:05:24 -07:00
using_osd_hbr.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00
using_osd_textures.rst Updating EULA 2013-07-18 15:05:24 -07:00
using_osd.rst adding Osd documentation based on Siggraph slides 2013-07-29 19:14:19 -07:00

       Copyright 2013 Pixar

       Licensed under the Apache License, Version 2.0 (the "License");
       you may not use this file except in compliance with the License
       and the following modification to it: Section 6 Trademarks.
       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 for reproducing
       the content of the NOTICE file.

       You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

       Unless required by applicable law or agreed to in writing,
       software distributed under the License is distributed on an
       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
       either express or implied.  See the License for the specific
       language governing permissions and limitations under the
       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