OpenSubdiv/documentation
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
..
css Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
images Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
tipuesearch Incremental commit for the new HTML documentation system: 2013-07-04 10:47:56 -07:00
api_overview.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
cmake_build.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
CMakeLists.txt Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
code_examples.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
diagrams.odg Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
dxviewer.rst intermediate documentation check-in : adding content 2013-07-05 18:41:04 -07:00
getting_started.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
glbatchviewer.rst intermediate documentation check-in : adding content 2013-07-05 18:41:04 -07:00
glviewer.rst intermediate documentation check-in : adding content 2013-07-05 18:41:04 -07:00
intro.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
limiteval.rst intermediate documentation check-in : adding content 2013-07-05 18:41:04 -07:00
nav_template.txt Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
OpenSubdiv.doxy Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
processHtml.py Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
ptexviewer.rst intermediate documentation check-in : adding content 2013-07-05 18:41:04 -07:00
README Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
release_notes.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
rst_template.txt Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
search.html Incremental commit for the new HTML documentation system: 2013-07-04 10:47:56 -07:00
subdivision_surfaces.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
using_osd_compile.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
using_osd_hbr.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
using_osd_textures.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00
using_osd.rst Intermediate documentation check-in 2013-07-07 18:20:46 -07:00

       Copyright (C) Pixar. All rights reserved.
  
       This license governs use of the accompanying software. If you
       use the software, you accept this license. If you do not accept
       the license, do not use the software.
  
       1. Definitions
       The terms "reproduce," "reproduction," "derivative works," and
       "distribution" have the same meaning here as under U.S.
       copyright law.  A "contribution" is the original software, or
       any additions or changes to the software.
       A "contributor" is any person or entity that distributes its
       contribution under this license.
       "Licensed patents" are a contributor's patent claims that read
       directly on its contribution.
  
       2. Grant of Rights
       (A) Copyright Grant- Subject to the terms of this license,
       including the license conditions and limitations in section 3,
       each contributor grants you a non-exclusive, worldwide,
       royalty-free copyright license to reproduce its contribution,
       prepare derivative works of its contribution, and distribute
       its contribution or any derivative works that you create.
       (B) Patent Grant- Subject to the terms of this license,
       including the license conditions and limitations in section 3,
       each contributor grants you a non-exclusive, worldwide,
       royalty-free license under its licensed patents to make, have
       made, use, sell, offer for sale, import, and/or otherwise
       dispose of its contribution in the software or derivative works
       of the contribution in the software.
  
       3. Conditions and Limitations
       (A) No Trademark License- This license does not grant you
       rights to use any contributor's name, logo, or trademarks.
       (B) If you bring a patent claim against any contributor over
       patents that you claim are infringed by the software, your
       patent license from such contributor to the software ends
       automatically.
       (C) If you distribute any portion of the software, you must
       retain all copyright, patent, trademark, and attribution
       notices that are present in the software.
       (D) If you distribute any portion of the software in source
       code form, you may do so only under this license by including a
       complete copy of this license with your distribution. If you
       distribute any portion of the software in compiled or object
       code form, you may only do so under a license that complies
       with this license.
       (E) The software is licensed "as-is." You bear the risk of
       using it. The contributors give no express warranties,
       guarantees or conditions. You may have additional consumer
       rights under your local laws which this license cannot change.
       To the extent permitted under your local laws, the contributors
       exclude the implied warranties of merchantability, fitness for
       a particular purpose and non-infringement.


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