mirror of
https://github.com/PixarAnimationStudios/OpenSubdiv
synced 2024-09-19 22:30:05 +00:00
8456c703fa
- 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 |
||
|---|---|---|
| .. | ||
| css | ||
| images | ||
| tipuesearch | ||
| additional_resources.rst | ||
| api_overview.rst | ||
| cmake_build.rst | ||
| CMakeLists.txt | ||
| code_examples.rst | ||
| diagrams.odg | ||
| downloads.rst | ||
| dxptexviewer.rst | ||
| dxviewer.rst | ||
| examples_see_also.rst | ||
| far_overview.rst | ||
| getting_started.rst | ||
| glbatchviewer.rst | ||
| glevallimit.rst | ||
| glfvarviewer.rst | ||
| glpainttest.rst | ||
| glptexviewer.rst | ||
| glsharetopology.rst | ||
| glstencilviewer.rst | ||
| glviewer.rst | ||
| hbr_overview.rst | ||
| intro.rst | ||
| license.rst | ||
| maya_osdpolysmooth.rst | ||
| mod_notes.rst | ||
| nav_template.txt | ||
| OpenSubdiv.doxy | ||
| osd_overview.rst | ||
| processHtml.py | ||
| processTutorials.py | ||
| README | ||
| release_notes_2x.rst | ||
| release_notes.rst | ||
| roadmap.rst | ||
| rst_template.txt | ||
| sdc_overview.rst | ||
| search.html | ||
| subdivision_surfaces.rst | ||
| tutorials.rst | ||
| under_development.rst | ||
| using_osd_compile.rst | ||
| using_osd_hbr.rst | ||
| using_osd_textures.rst | ||
| using_osd.rst | ||
| vtr_overview.rst | ||
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