web

SainsburyWellcomeCentre · Nov 4, 2024 · 9c85464 · 9c85464
1 parent 51e2a61
commit 9c85464
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 32 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
+-e .
 linkify-it-py
 myst-parser
 nbsphinx
@@ -6,3 +7,4 @@ setuptools-scm
 sphinx
 sphinx-autodoc-typehints
 sphinx-sitemap
+sphinx-design
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/index.rst b/docs/source/index.rst
@@ -6,41 +6,12 @@
 Welcome to NeuralPlayground's documentation!
 =========================================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+ .. include:: ../../README.md
+    :parser: myst_parser.sphinx_
 
-   getting_started
-   api_index
 
-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``.
-* API: here you can find the auto-generated documentation of your package, which is based on the docstrings in your code. To modify which modules/classes/functions are included in the API documentation, edit the file ``docs/source/api_index.rst``.
-
-You can create additional sections with narrative documentation,
-by adding new ``.md`` or ``.rst`` files to the ``docs/source`` folder.
-These files should start with a level-1 (H1) header,
-which will be used as the section title. Sub-sections can be created
-with lower-level headers (H2, H3, etc.) within the same file.
-
-To include a section in the rendered documentation,
-add it to the ``toctree`` directive in this (``docs/source/index.rst``) file.
-
-For example, you could create a ``docs/source/installation.md`` file
-and add it to the ``toctree`` like this:
-
-.. code-block:: rst
-
-   .. toctree::
-      :maxdepth: 2
-      :caption: Contents:
-
-      getting_started
-      installation
-      api_index
 
 Index & Search
 --------------
 * :ref:`genindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/source/read_me.rst b/docs/source/read_me.rst
@@ -0,0 +1,7 @@
+Readme File
+
+
+ ===========
+
+
+