summaryrefslogtreecommitdiff
path: root/api-docs/source/index.rst
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2016-07-24 20:09:48 -0400
committerJordan Wiens <jordan@psifertex.com>2016-07-24 20:09:48 -0400
commitf8f7ae14bec054170d69d8fd4de0c453b3c34798 (patch)
treee19f73b8db0fc374b2d96c2121705f38302e6d5d /api-docs/source/index.rst
parentb1900d6ebcc39738885f90fa9f18b28206a74947 (diff)
add initial api documentation for C++, C, and Python generated with sphinx, breathe, and doxygen mostly working on the framework, lots left undocumented
Diffstat (limited to 'api-docs/source/index.rst')
-rw-r--r--api-docs/source/index.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/api-docs/source/index.rst b/api-docs/source/index.rst
new file mode 100644
index 00000000..25614b2c
--- /dev/null
+++ b/api-docs/source/index.rst
@@ -0,0 +1,26 @@
+.. Binary Ninja API documentation master file, created by
+ sphinx-quickstart on Tue Jun 28 23:02:45 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+.. include global.rst
+
+Binary Ninja API Documentation
+==============================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ Python API <python>
+ C API <c>
+ C++ API <c++>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+