diff --git a/docs/index.rst b/docs/index.rst index 3c84af43339a10699504f43ad7edae10624ab3de..38dc9a6a2041dfe76ee744a9a61f46edffbc1ac6 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 0000000000000000000000000000000000000000..9836297df149c6d611a7c6227422c87358ad22c6 --- /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: +