diff options
| author | Marc André Tanner <mat@brain-dump.org> | 2017-04-28 23:14:22 +0200 |
|---|---|---|
| committer | Marc André Tanner <mat@brain-dump.org> | 2017-05-03 10:42:04 +0200 |
| commit | 62eea997d2b5ff9b30f3d562121fd0839e1fe0f1 (patch) | |
| tree | 96c5a371d2e2d18fcdfb862a849e902fa36cb7e6 /doc | |
| parent | 7c5eef1097425cfbcccb4745e7915fa3e547cd6b (diff) | |
| download | vis-62eea997d2b5ff9b30f3d562121fd0839e1fe0f1.tar.gz vis-62eea997d2b5ff9b30f3d562121fd0839e1fe0f1.tar.xz | |
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 (limited to 'doc')
| -rw-r--r-- | doc/.gitignore | 1 | ||||
| -rw-r--r-- | doc/index.rst | 28 | ||||
| -rw-r--r-- | doc/requirements.txt | 1 |
3 files changed, 30 insertions, 0 deletions
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 |