/private-chef-administration

Private Chef Administration Guide

Primary LanguagePython

Private Chef Administration Guide

This repository has the source material for the Private Chef Administration guide.

Prerequisites

To use this documentation, you'll need to have Sphinx installed, along with Pygments for syntax highlighting. If you want to generate PDF documentation, you'll also need to have a version of LaTeX installed (specifically latex2pdf).

Installation

$ easy_install Pygments
$ easy_install sphinx

Build

To build the documentation:

export LC_ALL=en_US.UTF
export LANG=en_US.UTF-8
$ make html

Will generate HTML output in build/html/index.html.

Run:

$ make help

For alternative formats.

Publish

Use 'make upload' to upload to s3. Requires that you have Opscode internal credentials configured for s3cmd.