more docs and move contents.rst to index.rst

docs/source/conf.py

@@ -8,7 +8,6 @@
 author = 'Daniel Otten, Jakob Wuhrer, Julia Bolt, Ricardo Schaaf, and Yannik Marchand'
 release = '0.1.0'
 
-master_doc = 'contents'
 extensions = ['sphinx.ext.autodoc']
 exclude_patterns = []
 

docs/source/contents.rst → docs/source/index.rst

@@ -2,10 +2,16 @@ in-toolset's documentation
 ==========================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
+in-toolset is an editor and (basic) simulator for industry workflow nets (inets), a model of interorganisational workflows based on petrinets.
 
+Currently, the tool supports editing and manually simulating these industry workflows, and exporting industry nets as PNML petri nets, but support for checking for bisimilarity using LTSmin and for generating the language of triggering sequences of an inet in XES is planned, as is a model of "domains" for organisations and messages.
+
+The toolset was originally created by: Daniel Otten, Jakob Wuhrer, Julia Bolt, Ricardo Schaaf, and Yannik Marchand, on behalf of Pieter Kwantes of Leiden University.
+
+It is provided here licensed under the GPL version 3.
 
 Indices and tables
 ==================
@@ -15,13 +21,8 @@ Indices and tables
 * :ref:`search`
 
 
-Common
-======
-
-in_toolset
-----------
-.. automodule:: in_toolset
-   :members:
+Submodules
+==========
 
 common
 ------
@@ -43,76 +44,80 @@ main
 
 
 Model
-=====
+-----
+.. automodule:: in_toolset.model
+   :members:
 
 model.base
-----------
+~~~~~~~~~~
 .. automodule:: in_toolset.model.base
    :members:
 
 model.pnml
-----------
+~~~~~~~~~~
 .. automodule:: in_toolset.model.pnml
    :members:
 
 model.project
--------------
+~~~~~~~~~~~~~
 .. automodule:: in_toolset.model.project
    :members:
 
 model.ui
---------
+~~~~~~~~
 .. automodule:: in_toolset.model.ui
    :members:
 
 
 
 
 User Interface
-==============
+--------------
+.. automodule:: in_toolset.ui
+   :members:
 
 ui.app
-------
+~~~~~~
 .. automodule:: in_toolset.ui.app
    :members:
 
 ui.common
----------
+~~~~~~~~~
 .. automodule:: in_toolset.ui.common
    :members:
 
 ui.enterprise
--------------
+~~~~~~~~~~~~~
 .. automodule:: in_toolset.ui.enterprise
    :members:
 
 ui.industry
------------
+~~~~~~~~~~~
 .. automodule:: in_toolset.ui.industry
    :members:
 
 ui.menu
--------
+~~~~~~~
 .. automodule:: in_toolset.ui.menu
    :members:
 
 ui.scene
---------
+~~~~~~~~
 .. automodule:: in_toolset.ui.scene
    :members:
 
 ui.tools
---------
+~~~~~~~~
 .. automodule:: in_toolset.ui.tools
    :members:
 
 ui.view
--------
+~~~~~~~
 .. automodule:: in_toolset.ui.view
    :members:
 
 ui.window
----------
+~~~~~~~~~
 .. automodule:: in_toolset.ui.window
    :members:
 

in_toolset/config.py

@@ -1,3 +1,6 @@
+"""The config module allows for configuration of the behaviour of in-toolset,
+using a text file with key-value items as storage for the settings"""
+
 import os
 
 class Config:

in_toolset/model/__init__.py

@@ -0,0 +1,3 @@
+"""The :py:mod:`in_toolset.model` module contains code for modelling the behaviour of petri nets, industry nets and generic uncoloured petri nets.
+
+It relies heavily on the signalling and property classes in :py:mod:`in_toolset.common`."""