update docs with toctree and api file

stonecharioteer · Aug 24, 2019 · dbbd8a4 · dbbd8a4
1 parent e173fdb
commit dbbd8a4
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,7 @@
+======
+API
+======
+
+.. todo::
+
+    Include documentation for the source code here.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,7 +32,8 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
-    "sphinx.ext.viewcode"
+    "sphinx.ext.viewcode",
+    "sphinx.ext.todo"
 ]
 
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,8 +10,8 @@ Welcome to asciinema-director's documentation!
 `asciinema-director` is an easier way to use `asciinema`, the amazing terminal
 recording tool.
 
-I've used asciinema for a very long time and the biggest problem is making flawless
-recordings.
+I've used asciinema for a very long time and the biggest problem is making
+flawless recordings.
 
 This project seeks to automate the creation of those recordings, using a source
 file that the user provides.
@@ -21,6 +21,13 @@ file that the user provides.
     This project is in alpha stage, and is not ready for testing. Consult the
     github project page for more information.
 
+
+.. toctree::
+    :maxdepth: 2
+
+    api
+
+
 Indices and tables
 ==================