doc: Start documentation for extending aerovaldb

metno · Sep 3, 2024 · df6e599 · df6e599
1 parent c2358bb
commit df6e599
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/docs/extending-aerovaldb.rst b/docs/extending-aerovaldb.rst
@@ -0,0 +1,9 @@
+Extending AerovalDB
+===================
+
+AerovalDB is designed to allow custom implementations to allow storage in new storage formats. This is done by writing a new class inheriting from :class:`aerovaldb.AerovalDB`.
+
+Unless overridden, getters and setters will be routed to :meth:`aerovaldb.AerovalDB._get` and :meth:`aerovaldb.AerovalDB._put` respectively, so this is were the main read and write behaviour should be implemented. These functions receive a route, as well as arguments based on which to get/put data and are intended to be used based on route-lookup (for example, :class:`aerovaldb.jsondb.jsonfiledb.AerovalJsonFileDB` translates the route into a file path template, while :class:`aerovaldb.sqlitedb.sqlitedb.AerovalSqliteDB` translates the route into a table name).
+
+URI Scheme
+----------
diff --git a/docs/index.rst b/docs/index.rst
@@ -52,6 +52,7 @@ Writing
    installation
    api
    locking
+   extending-aerovaldb
    genindex
 
 Indices and tables

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -10,8 +10,8 @@ This will install the latest stable aerovaldb version from PyPi:
 ::
 	pip install aerovaldb
 
-Development releases
-^^^^^^^^^^^^^^^^^^^^
+Development releases:
+^^^^^^^^^^^^^^^^^^^^^
 
 This will install the most recent development version from Github:
 ::