daniel/pylib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update docstring

Browse Source
This commit is contained in:
Daniel Weschke
2026-01-22 18:50:07 +01:00
parent d0eabd3252
commit 22cc4f2943
46 changed files with 3647 additions and 1624 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/source/index.rst
View File

@@ -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.