Skip to content

Commit 8f73b6a

Browse files
deploy: 7bc8f16
0 parents  commit 8f73b6a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+6416
-0
lines changed

.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 9487b9b1a9380522b88edb1c99f3bbb7
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

.doctrees/api.doctree

7.36 KB
Binary file not shown.

.doctrees/datasources.doctree

2.4 KB
Binary file not shown.

.doctrees/environment.pickle

25.9 KB
Binary file not shown.

.doctrees/external.doctree

2.41 KB
Binary file not shown.

.doctrees/index.doctree

5.63 KB
Binary file not shown.
2.13 KB
Binary file not shown.

.doctrees/tutorial.doctree

25.4 KB
Binary file not shown.

.nojekyll

Whitespace-only changes.

_sources/api.rst.txt

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
API Reference
2+
=============
3+
4+
OSHConnect
5+
----------
6+
7+
8+
OSHConnect Utilities and Helpers
9+
--------------------------------
10+
.. automodule:: oshconnect.oshconnectapi
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
OSH Connect Data Models
16+
-----------------------
17+
These are the second highest level pieces in the hierarchy of the library and the utilities needed to help almost
18+
everything else in the app function.
19+
20+
.. automodule:: oshconnect.osh_connect_datamodels
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
26+
DataSources and Messaging
27+
-------------------------
28+
Due to their extreme importance in the library, the data sources are listed separately along with the classes that help
29+
manage them and their data.
30+
31+
.. automodule:: oshconnect.datasource
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
Time Management
37+
---------------
38+
Currently **WIP** but this module will contain the classes and functions that help manage the current time and other
39+
playback features of groups of datasources/datafeeds
40+
41+
.. automodule:: oshconnect.timemanagement
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
Styling
47+
-------
48+
**WIP** This module contains the classes and functions that help manage the styling and visualization recommendations that
49+
the library provides.
50+
51+
Datastore
52+
---------
53+
**WIP** This module is for managing the state of the app. The configurations files are intended to be interchgangale
54+
among all language versions of the OSHConnect ecosystem.
55+
56+
Core Data Models
57+
----------------
58+
Theses data models are not often intended to be used directly by the user, but are used by the library to help manage
59+
validation of data that flows to and from the API.
60+
61+
.. automodule:: oshconnect.core_datamodels
62+
:members:
63+
:undoc-members:
64+
:show-inheritance:
65+
66+
67+
68+
Helpers
69+
~~~~~~~

0 commit comments

Comments
 (0)