mkdocs: Link to API documentation.

cmusatyalab · Dec 24, 2015 · d45ed00 · d45ed00
1 parent 4883f10
commit d45ed00
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/usage.md b/docs/usage.md
@@ -1,5 +1,9 @@
 # Usage
-## Existing Models
+
+## [API Documentation](http://openface-api.readthedocs.org/en/latest/index.html)
+
+## Example
+
 See [the image comparison demo](https://github.com/cmusatyalab/openface/blob/master/demos/compare.py) for a complete example
 written in Python using a naive Torch subprocess to process the faces.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -15,7 +15,7 @@ pages:
   - Demo 2 - Comparison: demo-2-comparison.md
   - Demo 3 - Training a Classifier: demo-3-classifier.md
 - User Guide:
-  - Usage: usage.md
+  - Usage and API Docs: usage.md
   - Setup: setup.md
   - FAQ: faq.md
 - DNN Models: