Merge pull request #94 from miniscope/docs-api

Docs: API

Author: raymondwjang

docs/api/runner.md docs/api/asset.mddocs/api/runner.md renamed to docs/api/asset.md

@@ -1,7 +1,7 @@
-# `runner`
+# `asset`
 
 ```{eval-rst}
-.. automodule:: noob.runner
+.. automodule:: noob.asset
     :members:
     :undoc-members:
 ```

docs/api/config.md

@@ -1,7 +1,13 @@
 # `config`
 
 ```{eval-rst}
-.. automodule:: noob.config
+.. autopydantic_model:: noob.config.Config
     :members:
     :undoc-members:
+```
+
+```{eval-rst}
+.. automodule:: noob.config
+    :members:
+    :exclude-members: Config
 ```

docs/api/const.md

@@ -0,0 +1,7 @@
+# `const`
+
+```{eval-rst}
+.. automodule:: noob.const
+    :members:
+    :undoc-members:
+```

docs/api/exceptions.md

@@ -1,7 +1,12 @@
 # `exceptions`
 
+```{inheritance-diagram} noob.exceptions
+:parts: 1
+```
+
 ```{eval-rst}
 .. automodule:: noob.exceptions
     :members:
     :undoc-members:
+    :show-inheritance: 
 ```

docs/api/index.md

@@ -1,16 +1,61 @@
 # API
 
+## Main modules
+
+Core functionality, main public interface
+
+- [**node**](./node/index.md) - Units of a processing graph
+- [**tube**](./tube.md) - A whole processing graph!
+- [**runner**](./runner/index.md) - The thing that executes the processing graph
+
+## Secondary modules
+
+Models, mixins, and helper classes that support the main modules and are also part of the public interface
+
+- [**asset**](./asset.md) - Static objects that can persist through graph processing cycles
+- [**config**](./config.md) - Control how noob works
+- [**event**](./event.md) - Data models for events
+- [**input**](./input.md) - Types and collections for handling tube inputs
+- [**network**](./network/index.md) - Data models and support for networked runners
+- [**scheduler**](./scheduler.md) - Keeps track of which nodes should run when
+- [**state**](./state.md) - Manages [assets](./asset.md)
+- [**store**](./store.md) - Manages [events](./event.md)
+- [**types**](./types.md) - Annotated and validating types used throughout noob
+
+## Utility modules
+
+Internal or limited-use tools
+
+- [**const**](./const.md) - constants!
+- [**exceptions**](./exceptions.md) - Custom exceptions and warnings raised by noob
+- [**introspection**](./introspection.md) - Helpers for working with python type annotations
+- [**logging**](./logging.md) - what it says
+- [**testing**](./testing/index.md) - Nodes and other code useful for downstream packages testing things built with noob
+- [**utils**](./utils.md) - junk drawer
+- [**yaml**](./yaml.md) - Mixin for locating and parsing tube config files
+
+
 ```{toctree}
 :maxdepth: 2
+:hidden:
 
+asset
 config
+const
 event
 exceptions
+input
+introspection
 logging
-node
-runner
+network/index
+node/index
+runner/index
+scheduler
+state
 store
+testing/index
 tube
 types
+utils
 yaml
 ```

docs/api/input.md

@@ -0,0 +1,7 @@
+# `input`
+
+```{eval-rst}
+.. automodule:: noob.input
+    :members:
+    :undoc-members:
+```

docs/api/introspection.md

@@ -0,0 +1,7 @@
+# `introspection`
+
+```{eval-rst}
+.. automodule:: noob.introspection
+    :members:
+    :undoc-members:
+```

docs/api/network/index.md

@@ -0,0 +1,8 @@
+# `network`
+
+```{toctree}
+:maxdepth: 2
+
+loop
+message
+```

docs/api/network/loop.md

@@ -0,0 +1,7 @@
+# `loop`
+
+```{eval-rst}
+.. automodule:: noob.network.loop
+    :members:
+    :undoc-members:
+```

docs/api/network/message.md

@@ -0,0 +1,7 @@
+# `message`
+
+```{eval-rst}
+.. automodule:: noob.network.message
+    :members:
+    :undoc-members:
+```