aboutsummaryrefslogtreecommitdiffstats
path: root/doc/index.rst
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2022-03-26 21:08:23 +0000
committerYann Herklotz <git@yannherklotz.com>2022-03-26 21:08:23 +0000
commit11d6215f265d0dbcfd0048819a614f318a0775a4 (patch)
tree16b0450e4df7caaed57400d503044ca92f1f3c38 /doc/index.rst
parenta5b8a41ef22618c69db62dfeb71d7f38bbba34e2 (diff)
downloadvericert-11d6215f265d0dbcfd0048819a614f318a0775a4.tar.gz
vericert-11d6215f265d0dbcfd0048819a614f318a0775a4.zip
Add sphinx documentation
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..ebb99df
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,26 @@
+.. Vericert documentation master file, created by
+ sphinx-quickstart on Sat Mar 26 18:15:40 2022.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Vericert's Documentation
+========================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Content:
+
+ vericert
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Sources:
+
+ src/Compiler
+ src/hls/RTLBlockInstr
+
+Indices
+==================
+
+* :ref:`genindex`
+* :ref:`search`