SainsburyWellcomeCentre · niksirbi · Oct 22, 2024 · Oct 22, 2024 · Oct 22, 2024
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,8 +1,10 @@
+-e .
 linkify-it-py
 myst-parser
 nbsphinx
 pydata-sphinx-theme
 setuptools-scm
 sphinx
 sphinx-autodoc-typehints
+sphinx-design
 sphinx-sitemap
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
@@ -44,6 +45,7 @@
     "sphinx_sitemap",
     "myst_parser",
     "nbsphinx",
+    "sphinx_design",
 ]
 
 # Configure the myst parser to enable cool markdown features

diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md
@@ -5,7 +5,7 @@ Here you may demonstrate the basic functionalities your package.
 You can include code snippets using the usual Markdown syntax:
 
 ```python
-from my_package import my_function
+from NeuralPlayground import my_function
 
 result = my_function()
 ```
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,8 +10,14 @@ Welcome to NeuralPlayground's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   installation
    getting_started
    api_index
+   readme_link
+
+.. card:: Card Title
+
+    Card content
 
 By default the documentation includes the following sections:
 

diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -0,0 +1,3 @@
+# Install
+
+Do something.
diff --git a/docs/source/readme_link.rst b/docs/source/readme_link.rst
@@ -0,0 +1,6 @@
+Readme File
+===========
+
+.. include:: ../../README.md
+   :parser: myst_parser.sphinx_
+   :start-after: ## Usage