From 62eea997d2b5ff9b30f3d562121fd0839e1fe0f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Andr=C3=A9=20Tanner?= Date: Fri, 28 Apr 2017 23:14:22 +0200 Subject: 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. --- doc/.gitignore | 1 + doc/index.rst | 28 ++++++++++++++++++++++++++++ doc/requirements.txt | 1 + 3 files changed, 30 insertions(+) create mode 100644 doc/.gitignore create mode 100644 doc/index.rst create mode 100644 doc/requirements.txt diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..c795b05 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +build \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..1a0596c --- /dev/null +++ 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 new file mode 100644 index 0000000..cd6467e --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1 @@ +breathe -- cgit v1.2.3