document API

bast · Nov 27, 2016 · 2e06b66 · 2e06b66
1 parent e43a4f5
commit 2e06b66
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -21,24 +21,6 @@ created by [Ole Petter Bang](https://github.com/gnab).
 - [Roberto Di Remigio](https://github.com/robertodr) (MathJax support)
 
 
-## API
-
-### v1 (deprecated but supported)
-
-- Does not support files in subdirectories.
-```
-/v1/github/<namespace>/<repo>/<branch>/<file>/remark/
-```
-
-
-### v2
-
-- Supports files in subdirectories.
-```
-/v2/remark/github/<namespace>/<repo>/<branch>/<file>/
-```
-
-
 ## Environment variables
 
 `CICERO_URL_BASE`: defines the URL base for generated links in the Markdown file finder

diff --git a/doc/api.rst b/doc/api.rst
@@ -0,0 +1,21 @@
+
+
+v2
+==
+
+Supports files in subdirectories.
+
+::
+
+  /v2/remark/github/<namespace>/<repo>/<branch>/<file>/
+
+
+v1
+==
+
+This API is deprecated but supported.
+Does not support files in subdirectories.
+
+::
+
+  /v1/github/<namespace>/<repo>/<branch>/<file>/remark/
diff --git a/doc/index.rst b/doc/index.rst
@@ -2,3 +2,9 @@
 
 Cicero: Serving slides written in Markdown
 ==========================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API
+
+   api.rst