The Corbon documentation
Building a corbon site
To build a corbon site, the best thing to do is create a simple build script.
An example of a build script is provided as builddocs.py
, and
it generates the documentation site. It looks like this:
from corbon import buildSite buildSite('sources', 'site')
You can also provide some optional settings.
Tags
- <content>: Starts the content of your page
- <css>: Contains some style sheet information.
- <directory>: Links to all subdirectories in the current directory
- <filelist>: Generates a list of files for download
- <footer>: Places content at the bottom of the document
- <gifwrap>: Display a piece of text as a set of images
- <include>: Includes another XML file
- <keywordindex>: Generates a table of contents
- <locallink>: Links to other files in the same directory
- <nextpage>: Provides a link to the next page in the directory
- <prevpage>: Provides a link to the previous page in the directory
- <quickbutton>: Generates smart rollover images
- <script>: Includes some javascript code
- <seealso>: Links to other pages with the same keywords
- Build settings: Optional build settings
- <synopsis>: Describes the content of the page
- <tag>: Tag that contains a tag
- <title>: Defines the title of this page
- <uplink>: Links back up to its parent
- XHTML: How to use standard XHTML tags