Merge pull request #170 from flash62au/main

doco updates
DCC-EX · Jun 11, 2024 · 3fe278f · 3fe278f
2 parents 8076801 + 56931e5
commit 3fe278f
Show file tree

Hide file tree

Showing 5 changed files with 810 additions and 39 deletions.
diff --git a/docs/include/include.rst b/docs/include/include.rst
@@ -5,6 +5,11 @@
 
   <a href="https://dcc-ex.com/"><span class="dccex-suffix">DCC-</span><span class="dccex-prefix">EX</span></a>
 ..
+.. |EX-I| raw:: html
+
+  <a href="https://dcc-ex.com/"><span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;Installer</span></a>
+..
+..
 .. |EX-CS| raw:: html
 
   <a href="https://dcc-ex.com/"><span class="ex-prefix">EX</span><span class="ex-suffix">&#8209;CommandStation</span></a>

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,16 +8,17 @@ Documentation for the EX-Installer
   :hidden:
 
   EX-Installer <self>
+  running-and-building
   library
+  licence
 
 DCC-EX EX-Installer
---------------------------------------
+-------------------
 
-EX-Installer is a Python based, cross-platform installer for the various Arduino based DCC-EX products.
+|EX-I| is a Python based, cross-platform installer for the various Arduino based |DCC-EX| products.
 
 
+Usage
+-----
 
-Credits
--------
-
-
+Full instructions for using |EX-I| are available at https://dcc-ex.com/ex-installer/index.html
diff --git a/docs/library.rst b/docs/library.rst
@@ -5,8 +5,8 @@ Code Library
 
 ----
 
-welcome
--------
+Welcome (welcome.py)
+--------------------
 
 .. autoclass:: ex_installer.welcome.Welcome
     :members:
@@ -15,16 +15,16 @@ welcome
 
 ----
 
-ex_installer
-------------
+EX-Installer (ex_installer.py)
+------------------------------
 
 .. autoclass:: ex_installer.ex_installer.EXInstaller
     :members:
     :undoc-members:
     :private-members:
 
-manage_arduino_cli
-------------------
+Manage Arduino CLI (manage_arduino_cli.py)
+------------------------------------------
 
 .. autoclass:: ex_installer.manage_arduino_cli.ManageArduinoCLI
     :members:
@@ -33,8 +33,8 @@ manage_arduino_cli
 
 ----
 
-select_device
--------------
+Select Device (select_device.py)
+--------------------------------
 
 .. autoclass:: ex_installer.select_device.SelectDevice
     :members:
@@ -43,8 +43,8 @@ select_device
 
 ----
 
-select_product
---------------
+Select Product (select_product.py)
+----------------------------------
 
 .. autoclass:: ex_installer.select_product.SelectProduct
     :members:
@@ -53,8 +53,8 @@ select_product
 
 ----
 
-serial_monitor
---------------
+Serail Monitor (serial_monitor.py)
+----------------------------------
 
 .. autoclass:: ex_installer.serial_monitor.SerialMonitor
     :members:
@@ -63,11 +63,11 @@ serial_monitor
 
 ----
 
-EX CommandStation
+EX-CommandStation
 -----------------
 
-ex_commandstation
-^^^^^^^^^^^^^^^^^
+ex_commandstation.py
+^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ex_installer.ex_commandstation.EXCommandStation
     :members:
@@ -76,8 +76,8 @@ ex_commandstation
 
 ----
 
-select_version_config
-^^^^^^^^^^^^^^^^^^^^^
+Select Version (select_version_config.py)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ex_installer.select_version_config.SelectVersionConfig
     :members:
@@ -86,8 +86,8 @@ select_version_config
 
 ----
 
-advanced_config
-^^^^^^^^^^^^^^^
+Advanced Config (advanced_config.py)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ex_installer.advanced_config.AdvancedConfig
     :members:
@@ -97,8 +97,8 @@ advanced_config
 -----
 
 
-ex_ioexpander
--------------
+EX-IOExpander (ex_ioexpander.py)
+--------------------------------
 
 .. autoclass:: ex_installer.ex_ioexpander.EXIOExpander
     :members:
@@ -107,8 +107,8 @@ ex_ioexpander
 
 ----
 
-ex_turntable
-------------
+EX-Turntable (ex_turntable.py)
+------------------------------
 
 .. autoclass:: ex_installer.ex_turntable.EXTurntable
     :members:
@@ -117,8 +117,8 @@ ex_turntable
 
 ----
 
-arduino_cli
------------
+Arduino CLI (arduino_cli.py)
+----------------------------
 
 .. autoclass:: ex_installer.arduino_cli.ThreadedArduinoCLI
     :members:
@@ -135,8 +135,8 @@ arduino_cli
 Utility/Common
 --------------
 
-file_manager
-^^^^^^^^^^^^
+file_manager.py
+^^^^^^^^^^^^^^^
 
 .. autoclass:: ex_installer.file_manager.ThreadedDownloader
     :members:
@@ -155,8 +155,8 @@ file_manager
 
 ----
 
-common_fonts
-^^^^^^^^^^^^
+common_fonts.py
+^^^^^^^^^^^^^^^
 
 .. autoclass:: ex_installer.common_fonts.CommonFonts
     :members:
@@ -165,8 +165,8 @@ common_fonts
 
 ----
 
-common_widgets
-^^^^^^^^^^^^^^
+common_widgets.py
+^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ex_installer.common_widgets.WindowLayout
     :members:
@@ -190,8 +190,8 @@ common_widgets
 
 ----
 
-git_client
-^^^^^^^^^^
+git_client.py
+^^^^^^^^^^^^^
 
 .. autoclass:: ex_installer.git_client.ThreadedGitClient
     :members: