Merge pull request #246 from matrx-software/dev

Dev
matrx-software · Jan 15, 2021 · 42a91fa · 42a91fa
2 parents cc4e4f2 + 7adb810
commit 42a91fa
Show file tree

Hide file tree

Showing 21 changed files with 16 additions and 504 deletions.
diff --git a/dist/matrx-2.0.3-py3-none-any.whl b/dist/matrx-2.0.3-py3-none-any.whl
diff --git a/dist/matrx-2.0.3.tar.gz b/dist/matrx-2.0.3.tar.gz
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,11 +32,11 @@
 
 # -- Project information -----------------------------------------------------
 # The full version, including alpha/beta/rc tags
-release = '0.0.1'
+release = '2.0'
 
 project = 'MATRX %s Manual' % release
-copyright = '2019, The MATRX Team at TNO.nl'
-author = 'The MATRX Team at TNO.nl'
+copyright = '2020, The MATRX Team at matrx-software.com'
+author = 'The MATRX Team at matrx-software.com'
 
 
 # -- General configuration ---------------------------------------------------
@@ -106,7 +106,7 @@
 
 html_theme = 'sphinx_rtd_theme'
 
-html_static_path = ['tutorials/images', '_static', '../build/html/_static']
+html_static_path = ['_static', '../build/html/_static']
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/source/developer_info/changelog.rst b/docs/source/developer_info/changelog.rst
diff --git a/docs/source/developer_info/how_to_contribute.rst b/docs/source/developer_info/how_to_contribute.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,46 +13,17 @@
 MATRX documentation
 ======================
 
-Welcome! This is the documentation for Man-Agent Teaming; Rapid eXperimentation Software (MATRX).
+Welcome! This is the class and function reference documentation for the huMan-Agent Teaming; Rapid eXperimentation Software (MATRX).
 
-MATRX a 2D-discrete testbed to facilitate Human Agent Teaming (HAT) research. The original use case in MATRX is an urban search and rescue operation in which pairs of a human and an autonomous system have to locate and rescue victims. However, MATRX is very versatile and can, therefore, also be used in many other cases.
+After having installed MATRX (|matrx_install_guide|) and having tried out one or more tutorials (see the tutorials on the |matrx_tutorials|), additional information can be found here on specific classes, functions and parameters that are not described in a tutorial.
 
+.. |matrx_install_guide| raw:: html
 
-Getting started
-===============
-
-.. container:: hidden_caption
-
-   .. toctree::
-      :caption: Getting started
-      :maxdepth: 1
-
-      general_info/aboutmatrx.rst
-      installation/installing.rst
-      tutorials/tutorials.rst
-      tutorials/examples.rst
-      reference_by_category.rst
-
-
-For developers
-===============
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-   :caption: For Developers
-
-   developer_info/how_to_contribute.rst
-   developer_info/changelog.rst
-
-.. container:: bullet_list
-
-   * :ref:`How to contribute`
-   * :ref:`Changelog`
-   * :ref:`genindex`
-
+    <a href="https://matrx-software.com/docs/tutorials/basics/installation/" target="_blank">see installing MATRX</a>
 
+.. |matrx_tutorials| raw:: html
 
+    <a href="https://matrx-software.com/tutorials/" target="_blank">MATRX website</a>
 
 .. _Reference by Category:
 Reference by Category
@@ -78,7 +49,7 @@ Reference by Category
 
  .. container:: descr
 
-    .. figure:: _static//images/worlds_banner.jpg
+    .. figure:: _static/images/worlds_banner.jpg
        :target: sections/worlds.html
 
     :ref:`Worlds`
@@ -116,7 +87,6 @@ Reference by Category
     :ref:`Goals`
        Goals can be specified that track progress and determine when the simulation should end.
 
-
  .. container:: descr
 
     .. figure:: _static/images/shape_banner.jpg
@@ -125,7 +95,6 @@ Reference by Category
     :ref:`Cases`
        Defining a world containing objects, agents, actions, and simulation goals.
 
-
  .. container:: descr
 
     .. figure:: _static/images/utils_banner.jpg

diff --git a/docs/source/installation/installing.rst b/docs/source/installation/installing.rst
diff --git a/docs/source/reference_by_category.rst b/docs/source/reference_by_category.rst
@@ -1,4 +1,4 @@
-.. _Reference by category page
+.. _Reference:
 
 ================
 Reference by category
@@ -25,7 +25,7 @@ Reference by category
 
  .. container:: descr
 
-    .. figure:: _static//images/worlds_banner.jpg
+    .. figure:: _static/images/worlds_banner.jpg
        :target: sections/worlds.html
 
     :ref:`Worlds`

diff --git a/docs/source/sections/cases.rst b/docs/source/sections/cases.rst
@@ -1,4 +1,4 @@
-.. _Scenarios:
+.. _Cases:
 
 ==============
 Scenarios

diff --git a/docs/source/sections/objects.rst b/docs/source/sections/objects.rst
@@ -1,4 +1,4 @@
-.. _Object placement:
+.. _Objects:
 
 ================
 Object placement

diff --git a/docs/source/sections/simgoals.rst b/docs/source/sections/simgoals.rst
@@ -1,4 +1,4 @@
-.. _Simulation goals:
+.. _Goals:
 
 ================
 Simulation goals

diff --git a/docs/source/tutorials/adding_objects.rst b/docs/source/tutorials/adding_objects.rst
diff --git a/docs/source/tutorials/agent_implementation.rst b/docs/source/tutorials/agent_implementation.rst
diff --git a/docs/source/tutorials/bw4t_part1.rst b/docs/source/tutorials/bw4t_part1.rst