cerb-book's Introduction

Cerb User's Guide

http://www.cerbweb.com/

Introduction

These are the raw materials required to build the Cerb User's Guide in a variety of formats (HTML, ePub, PDF, Docbook, etc).

Requirements

The book utilizes the Sphinx documentation engine, and the files are in reStructuredText format. To modify and extend the documentation you only need a text editor.

You need to install Sphinx to convert the source files into production documentation.

You can reference reStructuredText syntax here: http://sphinx.pocoo.org/rest.html

Installing Sphinx

$ sudo easy_install sphinx
$ sudo easy_install sphinxcontrib-phpdomain

Creating an HTML manual

$ cd /path/to/cerb5-book
$ sphinx-build -b html -d _build/doctrees . _build/html

Credits

This project makes use of the following technology:

Python by Python Software Foundation and its contributions
Sphinx by The Pocoo Team
reStructuredText by Python Software Foundation and its contributors
OpenOffice by Oracle and its contibutors
ImageMagick by ImageMagick Studio LLC
TextMate by Macromates Ltd

License

The Cerb User's Guide by WebGroup Media LLC is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

You are free:

to Share -- to copy, distribute and transmit the work
to Remix -- to adapt the work

Under the following conditions:

Attribution -- You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).
Share Alike -- If you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.

Recommend Projects