2013-09-26 19:04:57 +00: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.
|
2013-07-04 17:47:56 +00:00
|
|
|
|
|
|
|
|
|
2013-07-08 01:20:46 +00:00
|
|
|
ReST Documentation
|
|
|
|
|
==================
|
2013-07-04 17:47:56 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2013-07-08 01:20:46 +00:00
|
|
|
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)
|
2013-07-04 17:47:56 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2013-07-08 01:20:46 +00:00
|
|
|
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.
|
|
|
|
|
|
2013-07-04 17:47:56 +00:00
|
|
|
|
2013-07-08 01:20:46 +00:00
|
|
|
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
|
2013-07-04 17:47:56 +00:00
|
|
|
|
|
|
|
|
|
