summaryrefslogtreecommitdiffstats
path: root/doc/overview.rst
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2023-09-02 19:23:21 -0400
committerDavid Robillard <d@drobilla.net>2023-09-02 19:23:21 -0400
commitce8a14731e78aa68b79f34396ad5dc3d7d7b8ea3 (patch)
tree49445ccb9ceb8fef189b1b41337f56c2364f94dd /doc/overview.rst
parent215c84198913c356f88e59df565027e2a8dbb43a (diff)
downloadsuil-ce8a14731e78aa68b79f34396ad5dc3d7d7b8ea3.tar.gz
suil-ce8a14731e78aa68b79f34396ad5dc3d7d7b8ea3.tar.bz2
suil-ce8a14731e78aa68b79f34396ad5dc3d7d7b8ea3.zip
Clean up documentation and remove junk files from install
Diffstat (limited to 'doc/overview.rst')
-rw-r--r--doc/overview.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/overview.rst b/doc/overview.rst
new file mode 100644
index 0000000..71937b2
--- /dev/null
+++ b/doc/overview.rst
@@ -0,0 +1,16 @@
+..
+ Copyright 2020-2022 David Robillard <d@drobilla.net>
+ SPDX-License-Identifier: ISC
+
+########
+Overview
+########
+
+.. default-domain:: c
+.. highlight:: c
+
+The complete API is declared in ``suil.h``:
+
+.. code-block:: c
+
+ #include <suil/suil.h>