forked from chef-boneyard/private-chef-administration
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding a README, config options, and ha admin
- Loading branch information
Showing
8 changed files
with
6,472 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# 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](http://sphinx.pocoo.org) installed, | ||
along with [Pygments](http://pygments.org) for syntax highlighting. If you want to generate | ||
PDF documentation, you'll also need to have a version of [LaTeX](http://www.latex-project.org/) | ||
installed (specifically latex2pdf). | ||
|
||
## Installation | ||
|
||
```bash | ||
$ easy_install Pygments | ||
$ easy_install sphinx | ||
``` | ||
|
||
## Build | ||
|
||
To build the documentation: | ||
|
||
```bash | ||
$ make html | ||
``` | ||
|
||
Will generate HTML output in build/html/index.html. | ||
|
||
Run: | ||
|
||
```bash | ||
$ make help | ||
``` | ||
|
||
For alternative formats. | ||
|
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.