test commit

SainsburyWellcomeCentre · Oct 22, 2024 · 031fe2d · 031fe2d
1 parent 67c8fb1
commit 031fe2d
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 1 deletion.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -5,4 +5,5 @@ pydata-sphinx-theme
 setuptools-scm
 sphinx
 sphinx-autodoc-typehints
+sphinx-design
 sphinx-sitemap
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -44,6 +44,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,9 +10,14 @@ Welcome to NeuralPlayground's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   installation
    getting_started
    api_index
 
+.. card:: Card Title
+
+    Card content
+
 By default the documentation includes the following sections:
 
 * Getting started. Here you could describe the basic functionalities of your package. To modify this page, edit the file ``docs/source/getting_started.md``.

diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -0,0 +1,3 @@
+# Install
+
+Do something.