vis

commit 7d1c4a1f254df73f29ec34c373e23847881a6f06
parent c3fca7ec90ec999d5ddac92121d72f9430a86673
Author: Marc André Tanner <mat@brain-dump.org>
Date:   Fri, 28 Apr 2017 23:14:22 +0200

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.

Diffstat:
A
doc/.gitignore
 | 
2
++
A
doc/index.rst
 | 
28
++++++++++++++++++++++++++++
A
doc/requirements.txt
 | 
1
+

3 files changed, 31 insertions(+), 0 deletions(-)
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -0,0 +1 @@
+build
+\ No newline at end of file
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