update doc

Author: MarkWendler

README.md

@@ -11,7 +11,7 @@ The pyx2cscope Python package communicates with X2Cscope enabled firmwares runni
   - Record data in run-time for AI models
   - Implement custom user interface, dashboards for embedded applications (QT, Tkinter, Web)
 
-Dor detailed documentation is hosted at GitHub.io:
+Detailed documentation is hosted at GitHub.io:
 [https://x2cscope.github.io/pyx2cscope/](https://x2cscope.github.io/pyx2cscope/)
 
 ## Install

doc/conf.py

@@ -80,3 +80,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
+
+html_theme_options = {
+    'navigation_depth': 4,
+}

doc/development.md

@@ -35,7 +35,7 @@ pip install -r requirements.txt
 pip install -r quality.txt
 ```
 
-## Runnin tests
+## Running tests
 
 ### ruff syntax check
 ```bash
@@ -55,11 +55,4 @@ sphinx-build -M html doc build --keep-going
 ## Creating executables
 ```bash
 pyinstaller --noconfirm .\pyx2cscope_win.spec 
-```
-
-
-Devcontainer
-docker folder contains devcontainer environment.
-.devcontainer is VSCode devcontainer environment
-Support
-commercial support is available through www.roxautomation.com
+```

doc/how_to.rst

@@ -1,5 +1,3 @@
-
-
 .. image:: images/pyx2cscope_logo.png
    :width: 180
    :alt: pyx2cscope
@@ -28,105 +26,21 @@ It allows user to:
    :alt: MCU<->PC
    :align: center
 
-Installation
-============
-
-Create a virtual environment and install pyx2cscope using the following commands (Windows):
-
-.. code-block:: python
-
-   python -m venv .venv
-   .venv\Scripts\activate
-   pip install pyx2cscope
-
-
-It is highly recommended to install python libraries underneath a virtual environment.
-
-Nevertheless, to install at system level, we advise to install it on user area. (Global insallation may not work.) 
-Execute the following lines:
-
-.. code-block:: python
-   
-   pip install --user pyx2cscope
-
-.. code-block:: python
-
-   pip install --upgrade pyx2cscope
-
-In case of unexpected issues executing pyx2cscope try to reinstall manually:
-
-.. code-block:: python
-   
-   pip uninstall pyx2cscope
-   pip cache purge
-   pip install --user pyx2cscope 
-
-
-After install you may check the current pyx2cscope version, in a terminal, run the following command:
-
-.. code-block:: python
-
-   pyx2cscope --version
-
-For help or additional command line options, type:
-
-.. code-block:: bash
-
-   pyx2cscope --help
-
-The log level used by pyX2Cscope is ERROR by default, possible values are
-DEBUG, INFO, WARNING, ERROR, and  CRITICAL. To set a different log level start
-pyX2Cscope with argument **-l** or **--log-level**
-
-.. code-block:: bash
-
-   pyx2cscope --log-level DEBUG
-
-Usage
------
-
-You may try pyX2Cscope either as an API to read and write values from/to variables in a running Microchip
-microcontroller, or as a Graphical User Interface (GUI), or both.
-
-The GUI interface
-~~~~~~~~~~~~~~~~~
-
-There are currently two implementations, one based on Qt and one Browser based. These GUIs are more examples
-on how to implement your own custom interfaces than an official user interface.
-
-To execute Qt version, type:
-
-.. code-block:: bash
-   
-   pyx2cscope
-
-To execute the Browser based version type:
-
-.. code-block:: bash
-
-   pyx2cscope -w
-
-
-The API interface
-~~~~~~~~~~~~~~~~~
-
-The API interface is managed over the X2CScope class.
-The simplest example of the API is depicted below:
-
-.. literalinclude:: ../pyx2cscope/examples/simplest.py
-    :language: python
-    :linenos:
 
-Following you will find specific information on the API, GUIs, and Firmware implementation.
+Following you will find specific information about Installation, API, GUIs, and Firmware implementation.
 See the section examples to check some of the usages you may get by pyX2Cscope.
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 1
    :caption: Contents:
 
-   how_to
+   install.rst
+   scripting.rst
+   gui_qt.md
+   gui_web.md
    FW_Support
    example
+   development.md
 
 Indices and tables
 ==================

doc/index.rst

@@ -0,0 +1,53 @@
+Installation
+============
+
+Create a virtual environment and install pyx2cscope using the following commands (Windows):
+
+.. code-block:: python
+
+   python -m venv .venv
+   .venv\Scripts\activate
+   pip install pyx2cscope
+
+
+It is highly recommended to install python libraries underneath a virtual environment.
+
+Nevertheless, to install at system level, we advise to install it on user area. (Global insallation may not work.) 
+Execute the following lines:
+
+.. code-block:: python
+   
+   pip install --user pyx2cscope
+
+.. code-block:: python
+
+   pip install --upgrade pyx2cscope
+
+In case of unexpected issues executing pyx2cscope try to reinstall manually:
+
+.. code-block:: python
+   
+   pip uninstall pyx2cscope
+   pip cache purge
+   pip install --user pyx2cscope 
+
+
+After install you may check the current pyx2cscope version, in a terminal, run the following command:
+
+.. code-block:: python
+
+   pyx2cscope --version
+
+For help or additional command line options, type:
+
+.. code-block:: bash
+
+   pyx2cscope --help
+
+The log level used by pyX2Cscope is ERROR by default, possible values are
+DEBUG, INFO, WARNING, ERROR, and  CRITICAL. To set a different log level start
+pyX2Cscope with argument **-l** or **--log-level**
+
+.. code-block:: bash
+
+   pyx2cscope --log-level DEBUG

doc/install.rst

@@ -1,9 +1,18 @@
-Scripting
-=========
+API Interface
+=============
+
+
+The API interface is managed over the X2CScope class. 
+
+Simplest example
+----------------
+
+.. literalinclude:: ../pyx2cscope/examples/simplest.py
+    :language: python
+    :linenos:
+
+Further examples in the repository: https://github.com/X2Cscope/pyx2cscope/tree/main/pyx2cscope/examples
 
-Once you have successfully installed pyX2Cscope into your environment or python project,
-start importing the X2CScope class. So you be able to read and write values from/to variables 
-inside the controller. Follow the steps below to get your script running.
 
 X2CScope class
 --------------

doc/scripting.rst

@@ -1,4 +1,6 @@
-"""ELF16 Parser for Microchip's XC16 Compiler.
+"""(Deprecated) ELF16 Parser for Microchip's XC16 Compiler.
+
+This module is deprecated and will be removed in future versions.
 
 This module defines the `Elf16Parser` class for parsing ELF files generated by Microchip's XC16 compiler.
 The parser extracts useful information about variables defined in the compiled program.