Added scaffolding for documentation.

rdadolf · rdadolf · commit 9621049b3c75 · 2016-10-04T23:41:07.000-04:00
Docs are generated using mkdocs and served via rtfd.io.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 *.pyc
 .*.swp
+.DS_Store
+deploy/
diff --git a/docs/assets/fathom.css b/docs/assets/fathom.css
@@ -0,0 +1,43 @@
+/* Fathom uses a light Open Sans for body and Gruppo for styled titles. */
+@import 'https://fonts.googleapis.com/css?family=Gruppo|Open+Sans';
+body, h1, h2, h3, h4, h5, h6, legend {
+  font-family: 'Open Sans', 'Helvetica Neue', 'Helvetica';
+  font-weight: 300;
+}
+/* Style all links in Fathom blue. */
+a, a:visited {
+  color: #007da5;
+}
+
+/***** Navigation Header *****/
+/* Remove the house icon near the title. */
+a.icon-home:before { content: ''; }
+/* Give the title a stylized look. */
+a.icon-home { /* Desktop */
+  color: #fcfcfc;
+  font-family: 'Gruppo';
+  font-size: 30pt;
+  font-weight: 400;
+  margin-bottom: 5px;
+}
+.wy-nav-top a { /* Mobile */
+  color: #fcfcfc;
+  font-family: 'Gruppo';
+  font-size: 24pt;
+  font-weight: 400;
+  margin-bottom: 5px;
+}
+
+/* Add water as a background on desktop, just Fathom blue on mobile. */
+.wy-side-nav-search { /* Desktop */
+  background: url(water-header.png) #007da5;
+  padding: 5px;
+}
+.wy-nav-top {
+  background-color: #007da5;
+}
+
+/***** Navigation Body *****/
+.wy-menu-vertical a {
+  color: #b3b3b3; /* Back to the default */
+}
diff --git a/docs/assets/water-header.png b/docs/assets/water-header.png
diff --git a/docs/faq.md b/docs/faq.md
@@ -0,0 +1,7 @@
+# Functions are missing from `cv2`
+
+Unfortunately, the `cv2` package in PyPI is not OpenCV. It's a name-squatter who has managed to upload a useless, empty package. There are a couple of ways to install OpenCV:
+
+1. Install from source by following the directions on the [OpenCV website](http://docs.opencv.org/2.4.13/doc/tutorials/introduction/linux_install/linux_install.html#linux-installation).
+2. Install via apt: `sudo apt-get install python-opencv`.
+3. Install using Anaconda: `conda install opencv`.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,2 @@
+# Fathom
+Reference workloads for modern deep learning.
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -0,0 +1,7 @@
+# Getting Fathom
+
+# Installing the Prerequisites
+
+# Downloading Data
+
+# Running the Workloads
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,13 @@
+site_name: Fathom
+repo_url: https://github.com/rdadolf/fathom
+site_description: 'Fathom: Reference Workloads for Modern Deep Learning Methods'
+google_analytics: ['UA-29492860-5', 'auto']
+
+theme: 'readthedocs'
+site_dir: 'deploy'
+extra_css: [assets/fathom.css]
+
+pages:
+  - 'Overview': index.md
+  - 'Getting Started': quickstart.md
+  - 'Frequently Asked Questions': faq.md
diff --git a/requirements.txt b/requirements.txt

-Original file line number
+Diff line change
@@ @@ -1,2 +1,4 @@ @@
 *.pyc
 .*.swp
 +.DS_Store
 +deploy/
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Fathom`
	`2`	`+Reference workloads for modern deep learning.`