summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--ChangeLog6
-rw-r--r--docs/api/combox.file.rst6
-rw-r--r--docs/api/index.rst8
-rw-r--r--docs/index.rst1
4 files changed, 21 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 437a793..dbca471 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
2015-12-23 Siddharth Ravikumar <sravik@bgsu.edu>
+ * docs/api/index.rst: Added.
+ * docs/api/combox.file.rst: Added.
+ * docs/index.rst: Added api/index to toc tree.
+
+2015-12-23 Siddharth Ravikumar <sravik@bgsu.edu>
+
* combox/file.py: updated docstring of all functions. The
docstrings are now palatable to sphinx to digest.
diff --git a/docs/api/combox.file.rst b/docs/api/combox.file.rst
new file mode 100644
index 0000000..1fb9ee4
--- /dev/null
+++ b/docs/api/combox.file.rst
@@ -0,0 +1,6 @@
+==================
+combox.file module
+==================
+
+.. automodule:: combox.file
+ :members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 0000000..0b1f8f4
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,8 @@
+=============
+api reference
+=============
+
+.. toctree::
+ :maxdepth: 2
+
+ combox.file
diff --git a/docs/index.rst b/docs/index.rst
index ba111e9..f698082 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,3 +9,4 @@
osx
windows
setup-combox
+ api/index