doc: update readme and update sphinx landing page

ika-rwth-aachen · Nov 30, 2023 · de09214 · de09214
1 parent 08de512
commit de09214
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -74,9 +74,9 @@ This repository provides a tool for the generation of road networks.
 Here, the main folders are named:
 
 -  ``doc``: Resources for documentation
--  ``io``: Sample input files
+-  ``examples``: Examlpe and Template files that showcase minimal working input networks
 -  ``src``: Source code
--  ``test``: Test files and their desired OpenDRIVE outputs
+-  ``test``: Test file .xml and .xodr pairs
 -  ``xml``: Contains the XSD validation files
 -  ``variation``: Python based variation tool for the road generator
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,7 +5,22 @@
 
 
 
-.. include:: ../README.rst
+Road Generation Documentation
+=============================
+
+Welcome to the documentation for `Road Generation <https://github.com/ika-rwth-aachen/RoadGeneration>`_!
+
+If you want to use the Road Generation tool you can can follow the `Installation instructions <https://ika-rwth-aachen.github.io/RoadGeneration/readmelink.html#installation>`_. 
+If you are unsure about the input format, we recommend to chekout the `Input Documentation <https://ika-rwth-aachen.github.io/RoadGeneration/inputdoc.html>`_. 
+
+Content
+^^^^^^^
+
+#. `Installation instructions <https://ika-rwth-aachen.github.io/RoadGeneration/readmelink.html#installation>`_
+#. `Variation Tool Documentation <https://ika-rwth-aachen.github.io/RoadGeneration/variationlink.html>`_
+#. `Input Documentation <https://ika-rwth-aachen.github.io/RoadGeneration/inputdoc.html>`_  
+
+
 
 .. toctree::
     :maxdepth: 3