From f24a8f77c7bfa44576db4de9b23030a1439c7899 Mon Sep 17 00:00:00 2001
From: Peter Bull <pjbull@gmail.com>
Date: Sat, 23 Apr 2016 12:19:28 -0400
Subject: [PATCH] Initial docs commit

---
 .gitignore         |  1 +
 docs/README.md     | 20 ++++++++++++++++++++
 docs/docs/index.md | 17 +++++++++++++++++
 docs/mkdocs.yml    |  4 ++++
 requirements.txt   |  3 +++
 5 files changed, 45 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 docs/README.md
 create mode 100644 docs/docs/index.md
 create mode 100644 docs/mkdocs.yml
 create mode 100644 requirements.txt

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0012cf8
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+docs/site/
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..4b4075d
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,20 @@
+Generating the docs
+----------
+
+Install requirements:
+
+    pip install -r requirements.txt
+
+Change directories into the docs folder:
+
+    cd docs
+
+Use [mkdocs](http://www.mkdocs.org/) structure to update the documentation. Test locally with:
+
+    mkdocs serve
+
+Once the docs look good, publish to `gh-pages` branch with:
+
+    mkdocs gh-deploy --clean
+
+** Note **: Never edit the generated site by hand because using `gh-deploy` blows away the `gh-pages` branch and you'll lose your edits.
diff --git a/docs/docs/index.md b/docs/docs/index.md
new file mode 100644
index 0000000..e053a9c
--- /dev/null
+++ b/docs/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to Peter
+
+For full documentation visit [mkdocs.org](http://mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs help` - Print this help message.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
new file mode 100644
index 0000000..8d311bf
--- /dev/null
+++ b/docs/mkdocs.yml
@@ -0,0 +1,4 @@
+site_name: My Docs
+theme: cinder
+pages:
+  - Home: index.md
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..ab0a33a
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs
+mkdocs-cinder
+cookiecutter