Merge pull request #21 from openego/feature/#20-basic-structure-of-docs

Replace section "Overview" by "Getting started"
openego · Oct 20, 2020 · 601fdc5 · 601fdc5
2 parents 5a19d39 + fa745ee
commit 601fdc5
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 23 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,8 +1,19 @@
-
+=========
 Changelog
 =========
 
-0.0.0 (2020-10-13)
-------------------
+Unreleased
+==========
+
+Added
+-----
+
+
+Changed
+-------
+
+* Adapt structure of the documentation to project specific requirements
+  `#20 <https://github.com/openego/eGon-data/issues/20>`_
 
-* First release on PyPI.
+Bug fixes
+---------
diff --git a/docs/conf.py b/docs/conf.py
@@ -13,6 +13,7 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
+    'sphinx.ext.autosectionlabel'
 ]
 source_suffix = '.rst'
 master_doc = 'index'

diff --git a/docs/data.rst b/docs/data.rst
@@ -0,0 +1,9 @@
+****
+Data
+****
+
+Scenarios
+=========
+
+Published data
+==============
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -0,0 +1,37 @@
+***************
+Getting Started
+***************
+
+Installation
+============
+
+Since no release is available on PyPi and installations are probably used for development, cloning
+
+.. code-block:: bash
+
+   git clone git@github.com:openego/eGon-data.git
+
+and installing in editable mode recommended.
+
+.. code-block:: bash
+
+   pip install -e eGon-data
+
+
+Pre-requisites
+==============
+
+Run the workflow
+================
+
+.. warning::
+
+   A complete run of the workflow might require much computing power and can't be run on laptop.
+   Use the :ref:`test mode <Test mode>` for experimenting.
+
+
+Test mode
+---------
+
+The workflow can be tested on a smaller subset of data on example of the federal state of Bremen.
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,13 +5,14 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   readme
-   installation
-   usage
-   reference/index
+   getting_started
+   workflow
+   data
+   literature
    contributing
    authors
    changelog
+   Module documentation <reference/index>
 
 Indices and tables
 ==================

diff --git a/docs/installation.rst b/docs/installation.rst
diff --git a/docs/literature.rst b/docs/literature.rst
@@ -0,0 +1,3 @@
+**********
+Literature
+**********
diff --git a/docs/readme.rst b/docs/readme.rst
diff --git a/docs/usage.rst b/docs/usage.rst
diff --git a/docs/workflow.rst b/docs/workflow.rst
@@ -0,0 +1,3 @@
+********
+Workflow
+********