a minimal API docs example

SainsburyWellcomeCentre · Oct 22, 2024 · 9f71c06 · 9f71c06
1 parent 031fe2d
commit 9f71c06
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
+-e .
 linkify-it-py
 myst-parser
 nbsphinx

diff --git a/docs/source/api_generated/neuralplayground.agents.agent_core.AgentCore.rst b/docs/source/api_generated/neuralplayground.agents.agent_core.AgentCore.rst
@@ -0,0 +1,6 @@
+neuralplayground.agents.agent\_core.AgentCore
+=============================================
+
+.. currentmodule:: neuralplayground.agents.agent_core
+
+.. autoclass:: AgentCore
diff --git a/docs/source/api_index.rst b/docs/source/api_index.rst
@@ -0,0 +1,13 @@
+API
+===
+
+Agent
+-----
+
+.. currentmodule:: neuralplayground.agents.agent_core
+
+.. autosummary::
+    :toctree: api_generated
+    :template: class.rst
+
+    AgentCore
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -25,6 +25,7 @@
 author = "University College London"
 try:
     release = setuptools_scm.get_version(root="../..", relative_to=__file__)
+    release = release.split(".dev")[0]
 except LookupError:
     # if git is not initialised, still allow local build
     # with a dummy version