The build process requires Python 2.7 and Doxygen 1.8.10, which can be downloaded from the doxygen website or installed via homebrew on OS X.

Compiled stylesheets are included in htmlsrc/_assets/css. Stylus is the CSS preprocessor of choice, which can be installed via npm.

• Install npm via homebrew

$ brew install npm

• Install stylesheet-building dependencies; from docs/stylesrc run:

$ npm install

• Build stylesheets; from docs/stylesrc run:

$ ./node_modules/.bin/gulp build

• Install Doxygen via homebrew

$ brew install doxygen

• Generate XML class descriptions from source files; from docs/doxygen run:

$ doxygen Doxyfile

• Generate HTML files from XML descriptors; from docs run:

$ python generateDocs.py

• Docs can now be viewed by opening docs/html/index.html in a local browser.

For more details on Cinder Docs read the Building Docs and Documenting Cinder Guides.