OpenSubdiv/documentation
George ElKoura 8456c703fa Minor fixes to building docs and doc links.
- Upped minimum required version of docutils from 0.6 to 0.9.
- Fixed link to pygments in build documentation
- Fixed link to doxygen in build documentation
2015-04-24 19:16:34 -07:00
..
css Fix documentation code highlighing 2014-12-04 11:30:22 -08:00
images Minor fixes on the documentation splash image 2015-02-03 13:17:34 -08: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 updates to documentation preceding Beta release. 2015-01-08 19:07:35 -08:00
cmake_build.rst Minor fixes to building docs and doc links. 2015-04-24 19:16:34 -07:00
CMakeLists.txt Add WIP downloads / EULA documentation page 2015-02-27 16:09:17 -08:00
code_examples.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
diagrams.odg Update subdivision ReST documentation to match changes in Sdc 2014-12-18 11:14:19 -08: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 Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
examples_see_also.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
far_overview.rst Updating documentation in readme and far_overview. 2015-04-12 18:13:23 -07:00
getting_started.rst Fix typo: "buf" -> "bug" 2015-02-25 18:03:41 -08:00
glbatchviewer.rst Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00
glevallimit.rst Add 'sticles' to the glEvalLimit code example 2014-09-30 18:53:47 -07:00
glfvarviewer.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
glpainttest.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
glptexviewer.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -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 Update documentation images of some gl code examples (glViewer, glEvalLimit, glStencilViewer) 2014-09-17 18:29:25 -07:00
hbr_overview.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
intro.rst Tiny doc fixes to intro and subdiv sections. 2015-04-03 18:29:10 -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 Add content / fix typos to modeling tips ReST documentation 2015-01-15 12:03:35 -08:00
nav_template.txt Adding modeling tips to ReST documentation 2015-01-14 18:11:10 -08:00
OpenSubdiv.doxy WIP doxyfication of Sdc 2014-12-22 11:29:15 -08:00
osd_overview.rst Updating beta issues in docs. 2015-04-06 22:09:14 -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 Minor fixes to release notes. 2015-04-03 23:42:22 -07:00
roadmap.rst Another handful of minor doc fixes. 2015-04-06 19:41:09 -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 Another handful of minor doc fixes. 2015-04-06 19:41:09 -07:00
search.html Amending Apache license language & file headers. 2013-09-26 12:04:57 -07:00
subdivision_surfaces.rst Updating beta issues in docs. 2015-04-06 22:09:14 -07:00
tutorials.rst Add automatic ReST pages to the documentation for the tutorials code 2014-12-01 15:52:58 -08:00
under_development.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
using_osd_compile.rst Another handful of minor doc fixes. 2015-04-06 19:41:09 -07:00
using_osd_hbr.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
using_osd_textures.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
using_osd.rst Landing 3.0.0.alpha 2014-09-05 15:07:46 -07:00
vtr_overview.rst Updating beta issues in docs. 2015-04-06 22:09:14 -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