summaryrefslogtreecommitdiffstats
path: root/doc/c/overview.rst
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-12-21 18:14:10 +0100
committerDavid Robillard <d@drobilla.net>2020-12-21 18:14:10 +0100
commitd361ce65d3841c9f97d27ac477c2e55c3802b381 (patch)
treec710d7deab629c6179ccf663f0421750b801a667 /doc/c/overview.rst
parentb3067e5a5dd1d92551d166a5095821e9033c0b7c (diff)
downloadsratom-d361ce65d3841c9f97d27ac477c2e55c3802b381.tar.gz
sratom-d361ce65d3841c9f97d27ac477c2e55c3802b381.tar.bz2
sratom-d361ce65d3841c9f97d27ac477c2e55c3802b381.zip
Generate documentation with Sphinx
Diffstat (limited to 'doc/c/overview.rst')
-rw-r--r--doc/c/overview.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/c/overview.rst b/doc/c/overview.rst
new file mode 100644
index 0000000..3b26a5b
--- /dev/null
+++ b/doc/c/overview.rst
@@ -0,0 +1,12 @@
+########
+Overview
+########
+
+.. default-domain:: c
+.. highlight:: c
+
+The complete API is declared in ``sratom.h``:
+
+.. code-block:: c
+
+ #include <sratom/sratom.h>