From d681f75d6f3bb0981fb748db2a701e45a66ca7a1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Sat, 28 Nov 2020 20:42:42 +0100
Subject: [PATCH] added a test for series
---
docs/index.rst | 1 +
docs/usage.rst | 13 +++++++++++++
2 files changed, 14 insertions(+)
create mode 100644 docs/usage.rst
diff --git a/docs/index.rst b/docs/index.rst
index 3c84af4..38dc9a6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,6 +11,7 @@ Welcome to tempsdb's documentation!
:caption: Contents:
time-series
+ usage
exceptions
It tries to use mmap for reads where possible, and in general be as zero-copy as possible (ie. the
diff --git a/docs/usage.rst b/docs/usage.rst
new file mode 100644
index 0000000..9836297
--- /dev/null
+++ b/docs/usage.rst
@@ -0,0 +1,13 @@
+Usage
+=====
+
+Start off by instantiating an object
+
+.. autoclass:: tempsdb.database.Database
+ :members:
+
+Then you can create and retrieve particular series:
+
+.. autoclass:: tempsdb.series.TimeSeries
+ :members:
+
--
GitLab