aboutsummaryrefslogtreecommitdiffstats
path: root/doc/c/overview.rst
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-12-20 20:20:07 +0100
committerDavid Robillard <d@drobilla.net>2020-12-21 09:48:06 +0100
commitf95f22013d51133ec1a7b1554878ff354b9f0f21 (patch)
tree2f65c78412fa9a083bc82e49480ba206fa14a689 /doc/c/overview.rst
parentfabf7113483ffd70024df989de3aa9361146d60c (diff)
downloadserd-f95f22013d51133ec1a7b1554878ff354b9f0f21.tar.gz
serd-f95f22013d51133ec1a7b1554878ff354b9f0f21.tar.bz2
serd-f95f22013d51133ec1a7b1554878ff354b9f0f21.zip
Generate documentation with Sphinx
Diffstat (limited to 'doc/c/overview.rst')
-rw-r--r--doc/c/overview.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/c/overview.rst b/doc/c/overview.rst
new file mode 100644
index 00000000..95862368
--- /dev/null
+++ b/doc/c/overview.rst
@@ -0,0 +1,22 @@
+########
+Overview
+########
+
+.. default-domain:: c
+.. highlight:: c
+
+The API revolves around two main types: the :doc:`api/reader`,
+which reads text and fires callbacks,
+and the :doc:`api/writer`,
+which writes text when driven by corresponding functions.
+Both work in a streaming fashion but still support pretty-printing,
+so the pair can be used to pretty-print, translate,
+or otherwise process arbitrarily large documents very quickly.
+The context of a stream is tracked by the :doc:`api/env`,
+which stores the current base URI and set of namespace prefixes.
+
+The complete API is declared in ``serd.h``:
+
+.. code-block:: c
+
+ #include <serd/serd.h>