DrawKit documentation

Building the Site

«  Licensing   ::   Contents   ::   Inherited To Do List  »

Building the Site

This web site is built using a collection of open source tools.

Install Homebrew

Homebrew is a package manager for Mac OS X. With Homebrew installed getting the required tools onto your Mac is much easier.

To install Homebrew run this command in your Terminal.app

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Install the Tools

With Homebrew installed, get the following tools

brew install doxygen
brew install graphviz
pip install sphinx
pip install breathe
doxygen extracts the documentation from the source code and turns it into browsable content.
graphviz is used by doxygen and sphinx to create diagrams. The class hierarchy diagrams are create by the graphviz tool dot.
sphinx turns the documentation you are reading now into a collection of web pages. The documentation is written in reStructuredText so it can be transformed into various useful formats for distribution, including this web site.
breathe provides a link between sphinx and doxygen. Sphinx was built for the python language and it does not parse Objective-C. doxygen does parse Objective-C and breath lets sphinx stand on the shoulders of doxygen.


With all the tools installed, you can build the document with the commands

cd documentation
make html

Building will take a few moments and the output will appear in the _build folder. The _build/html/ folder is published to the DrawKit web site.


A .nojekyll file is needed to allow github.io to serve contents from folders beginning with underscore (_).

«  Licensing   ::   Contents   ::   Inherited To Do List  »