diff --git a/README.md b/README.md index 6c06929..468b23c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# A lightweight simulation data creator and database manager +# simplesimdb: A lightweight simulation data creator and database manager + A python module for creation and management of simple simulation data. Essentially, a very basic database manager that creates its own data. diff --git a/docs/conf.py b/docs/conf.py index 75d4740..4270637 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ "sphinx.ext.intersphinx", "sphinx.ext.todo", "sphinx_autodoc_typehints", - "myst_nb", + "myst_parser", ] autosummary_generate = True diff --git a/docs/index.rst b/docs/index.rst index f605d88..73d791f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,22 +2,9 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -simplesimdb: A lightweight simulation data creator and database manager -======================================================================= -A python module for creation and management of simple simulation data. -Essentially, a very basic database manager that creates its own data. - -Simplesimdb is typically used to generate and analyse research data -from a Python script, where the data generation is done by an external -(typically highly optimized, written in C/C++ say) code that generates -an output for a given set of input parameters. The emphasize here is -on the fact that the parameter generation, code execution and data -management loop is **automated**, which allows the user to run large -parameter scans with a few lines of Python code **without manual -interference**. In this way for example publication grade plots can -be (re-)produced from scratch by just executing Python scripts. (See -for example the `impurities project `_) +.. include:: ../README.md + :parser: myst_parser.sphinx_ .. toctree:: :maxdepth: 2 diff --git a/pyproject.toml b/pyproject.toml index b82f5d1..1e2ad30 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,7 +31,7 @@ docs = [ "sphinx >= 5.3", "sphinx_autodoc_typehints >= 1.19", "sphinx-book-theme >= 0.4.0rc1", - "myst_nb", + "myst_parser", ] [build-system]