OpenSubdiv/documentation/README
2013-07-18 15:11:47 -07:00

68 lines
1.8 KiB
Plaintext

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