update docstring

docs/source/conf.py

@@ -34,8 +34,9 @@ release = '2019.12.21'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-  'sphinx.ext.autodoc',
+  'sphinx.ext.autodoc',   # see also autodoc_default_options below
   'sphinx.ext.viewcode',
+  'sphinx.ext.doctest',   # see also doctest_global_setup below
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -92,3 +93,11 @@ html_theme_options = {
 autodoc_default_options = {
   'special-members': '__iter__, __contains__, __getitem__, __setitem__, __pos__, __neg__, __add__, __iadd__, __sub__, __isub__, __mul__, __rmul__, __imul__, __matmul__, __imatmul__, __abs__, __lt__, __le__, __gt__, __ge__, __eq__, __ne__, __str__, __repr__'
 }
+
+doctest_global_setup = '''
+from pylib.data import *
+from pylib.mathematics import *
+from pylib.function import *
+from pylib.numerical.integration import *
+from pylib.geometry2d import *
+'''

docs/source/index.rst

@@ -7,7 +7,7 @@ Welcome to pylib's documentation!
 =================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 6
    :caption: Contents:
 
    modules
@@ -22,15 +22,20 @@ Indices and tables
 * :ref:`search`
 
 
+``data_step_std``
+-----------------
+.. image:: _static/class_diagram.svg
+  :target: _images/class_diagram.svg
 
-tui
----
 
-pylib/tui.py is the main module for tui 'terminal user interface' programs.
+``tui``
+-------
 
-* curses package (for Windows install windows-curses) is the underlying main
-  package to build terminal programs. The curses package can also be used
-  directly.
+``pylib/tui.py`` is the main module for tui 'textual user interface' programs.
+
+* ``curses`` package (for Windows install ``windows-curses``) is the underlying
+  main package to build terminal programs. The ``curses`` package can also be
+  used directly.
 
   * Windows (Anaconda):
 
@@ -38,9 +43,9 @@ pylib/tui.py is the main module for tui 'terminal user interface' programs.
     * ``python -m pip install windows-curses``
     * https://github.com/zephyrproject-rtos/windows-curses
 
-* drawille package is used to draw with braille characters (dottet and quasi-
-  line charts). Make sure you use a font with Unicode Braille characters. For
-  Windows e. g.: NSimSun, MS Gothic.
+* ``drawille`` package is used to draw with braille characters (dottet and
+  quasi-line charts). Make sure you use a font with Unicode Braille characters.
+  For Windows e. g.: NSimSun, MS Gothic.
 
   * Install: ``python -m pip install drawille``
   * Windows (Anaconda):
@@ -48,6 +53,5 @@ pylib/tui.py is the main module for tui 'terminal user interface' programs.
     * ``C:\PathToAnaconda3\condabin\conda.bat activate base``
     * ``python -m pip install drawille``
 
-* drawblock.py is used to draw with block characters (histogram).
-
-example/tui.py is an example script to build a terminal program.
+* ``drawblock`` is used to draw with block characters (histogram).
+* ``example/tui.py`` is an example script to build a terminal program.