From 9c8546413333331ecf132888609a432db1e75455 Mon Sep 17 00:00:00 2001 From: clementine Date: Mon, 4 Nov 2024 00:45:21 -0500 Subject: [PATCH] web --- docs/requirements.txt | 2 ++ docs/source/conf.py | 2 ++ docs/source/index.rst | 35 +++-------------------------------- docs/source/read_me.rst | 7 +++++++ 4 files changed, 14 insertions(+), 32 deletions(-) create mode 100644 docs/source/read_me.rst diff --git a/docs/requirements.txt b/docs/requirements.txt index 27a2626..e3bc094 100644 --- 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 \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index ba2dcc1..af45de9 100644 --- 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 index e8dac36..153c5f4 100644 --- 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` \ No newline at end of file diff --git a/docs/source/read_me.rst b/docs/source/read_me.rst new file mode 100644 index 0000000..dbfc57c --- /dev/null +++ b/docs/source/read_me.rst @@ -0,0 +1,7 @@ +Readme File + + + =========== + + +