From 523b6a67f69b140f7bdb3c7d7288b03bf365258e Mon Sep 17 00:00:00 2001
From: lkugler <lukas.kugler@gmail.com>
Date: Tue, 14 Mar 2023 16:22:58 +0100
Subject: [PATCH] .
---
docs/conf.py | 2 ++
docs/source/index.rst | 44 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 46 insertions(+)
create mode 100644 docs/source/index.rst
diff --git a/docs/conf.py b/docs/conf.py
index b6bad13..c052473 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,6 +13,8 @@ release = '2023.2.21'
# -- General configuration
sys.path.insert(0, os.path.abspath('../'))
+master_doc = 'index'
+
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..bb84e17
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,44 @@
+Welcome to the DART-WRF documentation!
+======================================
+
+**DART-WRF** is a python package to run an Ensemble Data Assimilation system using the data assimilation suite `DART <https://docs.dart.ucar.edu/en/latest/README.html>`_ and the weather research and forecast model `WRF <https://www2.mmm.ucar.edu/wrf/users/docs/docs_and_pubs.html>`_.
+
+Installation
+------------
+
+DART-WRF is available at `github.com/lkugler/DART-WRF <https://github.com/lkugler/DART-WRF>`_ using the command line:
+
+.. code-block::
+
+ git clone https://github.com/lkugler/DART-WRF.git
+ cd DART-WRF
+ pip install -e .
+
+
+Other helpful resources
+-----------------------
+
+**DART documentation** `[here] <https://docs.dart.ucar.edu/en/latest/README.html>`_
+**WRF user guide** `[here] <http://www2.mmm.ucar.edu/wrf/users/docs/user_guide_v4/v4.2/WRFUsersGuide_v42.pdf>`_
+
+
+.. toctree::
+ :hidden:
+
+ Home <self>
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Tutorials:
+
+ notebooks/test
+
+
+API
+===
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
--
GitLab