predict-idlab · Epse · May 20, 2025 · May 20, 2025
diff --git a/README.md b/README.md
@@ -65,6 +65,10 @@ Building is as follows:
 # uv run sphinx-build -M html docs/source/ docs/build/
 ```
 
+In case of major restructuring, it may be needed to clean up the contents of `docs/_autosummary` and potentially other rst files in `docs`,
+followed by re-running the build.
+Manually triggering sphinx-apidoc is unnecessary.
+
 ## Credits
 
 Base implementation originally by Pieter Moens <Pieter.Moens@ugent.be>,

diff --git a/docs/source/_autosummary/obelisk.asynchronous.Obelisk.rst b/docs/source/_autosummary/obelisk.asynchronous.Obelisk.rst
@@ -0,0 +1,41 @@
+obelisk.asynchronous.Obelisk
+============================
+
+.. currentmodule:: obelisk.asynchronous
+
+.. autoclass:: Obelisk
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Obelisk.__init__
+      ~Obelisk.fetch_single_chunk
+      ~Obelisk.http_post
+      ~Obelisk.query
+      ~Obelisk.query_time_chunked
+      ~Obelisk.send
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Obelisk.grace_period
+      ~Obelisk.token
+      ~Obelisk.token_expires
+      ~Obelisk.retry_strategy
+      ~Obelisk.kind
+      ~Obelisk.log
+
+
diff --git a/docs/source/_autosummary/obelisk.asynchronous.base.BaseClient.rst b/docs/source/_autosummary/obelisk.asynchronous.base.BaseClient.rst
@@ -0,0 +1,37 @@
+obelisk.asynchronous.base.BaseClient
+====================================
+
+.. currentmodule:: obelisk.asynchronous.base
+
+.. autoclass:: BaseClient
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BaseClient.__init__
+      ~BaseClient.http_post
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BaseClient.grace_period
+      ~BaseClient.token
+      ~BaseClient.token_expires
+      ~BaseClient.retry_strategy
+      ~BaseClient.kind
+      ~BaseClient.log
+
+
diff --git a/...ce/_autosummary/obelisk.sync.producer.rst → ...autosummary/obelisk.asynchronous.base.rst b/...ce/_autosummary/obelisk.sync.producer.rst → ...autosummary/obelisk.asynchronous.base.rst
@@ -1,7 +1,7 @@
-obelisk.sync.producer
-=====================
+obelisk.asynchronous.base
+=========================
 
-.. automodule:: obelisk.sync.producer
+.. automodule:: obelisk.asynchronous.base
 
 
    .. rubric:: Classes
@@ -10,5 +10,5 @@ obelisk.sync.producer
       :toctree:
       :template: custom-class-template.rst
 
-      Producer
+      BaseClient
 
diff --git a/docs/source/_autosummary/obelisk.asynchronous.client.Client.rst b/docs/source/_autosummary/obelisk.asynchronous.client.Client.rst
diff --git a/docs/source/_autosummary/obelisk.asynchronous.client.Obelisk.rst b/docs/source/_autosummary/obelisk.asynchronous.client.Obelisk.rst
@@ -0,0 +1,41 @@
+obelisk.asynchronous.client.Obelisk
+===================================
+
+.. currentmodule:: obelisk.asynchronous.client
+
+.. autoclass:: Obelisk
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Obelisk.__init__
+      ~Obelisk.fetch_single_chunk
+      ~Obelisk.http_post
+      ~Obelisk.query
+      ~Obelisk.query_time_chunked
+      ~Obelisk.send
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Obelisk.grace_period
+      ~Obelisk.token
+      ~Obelisk.token_expires
+      ~Obelisk.retry_strategy
+      ~Obelisk.kind
+      ~Obelisk.log
+
+
diff --git a/docs/source/_autosummary/obelisk.asynchronous.client.rst b/docs/source/_autosummary/obelisk.asynchronous.client.rst
@@ -10,5 +10,5 @@ obelisk.asynchronous.client
       :toctree:
       :template: custom-class-template.rst
 
-      Client
+      Obelisk
 
diff --git a/docs/source/_autosummary/obelisk.asynchronous.consumer.Consumer.rst b/docs/source/_autosummary/obelisk.asynchronous.consumer.Consumer.rst
diff --git a/docs/source/_autosummary/obelisk.asynchronous.consumer.rst b/docs/source/_autosummary/obelisk.asynchronous.consumer.rst
diff --git a/docs/source/_autosummary/obelisk.asynchronous.consumer_test.rst b/docs/source/_autosummary/obelisk.asynchronous.consumer_test.rst
diff --git a/docs/source/_autosummary/obelisk.asynchronous.consumer_test.test_demo_igent.rst b/docs/source/_autosummary/obelisk.asynchronous.consumer_test.test_demo_igent.rst
diff --git a/docs/source/_autosummary/obelisk.asynchronous.producer.Producer.rst b/docs/source/_autosummary/obelisk.asynchronous.producer.Producer.rst
diff --git a/docs/source/_autosummary/obelisk.asynchronous.producer.rst b/docs/source/_autosummary/obelisk.asynchronous.producer.rst
diff --git a/docs/source/_autosummary/obelisk.asynchronous.rst b/docs/source/_autosummary/obelisk.asynchronous.rst
@@ -1,17 +1,14 @@
-obelisk.asynchronous
+obelisk.asynchronous
 ====================
 
 .. automodule:: obelisk.asynchronous
 
 
-.. rubric:: Modules
+   .. rubric:: Classes
 
-.. autosummary::
-   :toctree:
-   :template: custom-module-template.rst
-   :recursive:
-
-   client
-   consumer
-   consumer_test
-   producer
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      Obelisk
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,5 +10,5 @@ obelisk.asynchronous.client @@
           :toctree:
           :template: custom-class-template.rst
-          Client
+          Obelisk