doc: add initial documentation files

If all required dependencies (doxygen, breathe, sphinx, sphinx_rtd_theme) are installed, then `make html` in the doc directory should generate sphinx based documentation in doc/build/sphinx.
microamp · May 3, 2017 · 62eea99 · 62eea99
1 parent 7c5eef1
commit 62eea99
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -0,0 +1 @@
+build
diff --git a/doc/index.rst b/doc/index.rst
@@ -0,0 +1,28 @@
+.. Vis Editor documentation master file, created by
+   sphinx-quickstart on Fri Apr 28 21:45:05 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Vis Editor's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+C API Documentation Test
+========================
+
+.. doxygenstruct:: Text
+.. doxygenfunction:: text_insert
+
+Here we have an inline text.
+
+.. doxygenenum:: TextSaveMethod
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1 @@
+breathe