This repository has the source material for the Private Chef Administration guide.
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).
easy_install Pygments easy_install sphinx
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.
For alternative formats.
Use 'make upload' to upload to s3. Requires that you have Opscode internal credentials configured for s3cmd.
brew install python
Now add the following to your PATH using the shell initialization script that makes sense for your environment:
You can now call
easy_install directly with no sudo and then follow
the make instructions.
A few minor nits for installing on OSX.
sudo easy_install Pygments sudo easy_install sphinx
You may have issues with ownership of
/Library/Python/2.7/site-packages/ after you build Pygments and sphinx. You can either change the ownership with:
sudo chown YOURUSER -R /Library/Python/2.7/site-packages
or make them world-executable with
sudo chmod -R 755 /Library/Python/2.7/site-packages
You can then use the
make commands as previously documented.
If you want iPad-readable docs, take the output of
and copy the
build/epub/PrivateChefGuide.epub to iTunes and sync it into the iBooks app.