Updated docs / configuration

src_docs/source/compiling.rst

@@ -10,7 +10,13 @@ I use the following tools in order to build and manage the software:
 * Visual Studio Code
 * PlatformIO
 * Git for Windows
-* VSCode plugin: Minify (used to minimise the html files)
+* Python3 (for building docs)
+
+.. note::
+
+  From v2 the User Interface is built in VueJS and stored in a separate project (mp-se/gravitymon-ui). The github build 
+  scripts will automatically fetch the latest version from that repository.
+
 
 Code Formatting
 ===============
@@ -20,7 +26,8 @@ I use pre-commit and their cpp style checks to validate the code. Plugin definti
 
 .. note::
 
-  There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu.
+  There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 
+  with Ubuntu or on MacOS.
 
 
 Targets 
@@ -37,8 +44,8 @@ In the platformio config there are 3 targets defined
 * gravity32lite-release: Version for ESP32 lite (Floaty hardware).
 
 .. warning::
-  The debug target can be unstable and crash the device under certain circumstanses. Excessive logging to the serial port can cause corruption and crashes. 
-  So only enable enough debugging to troubleshoot your changes.
+  The debug target can be unstable and crash the device under certain circumstanses. Excessive logging to the 
+  serial port can cause corruption and crashes. So only enable enough debugging to troubleshoot your changes.
 
 Serial debugging on battery
 ===========================
@@ -69,16 +76,16 @@ Source structure
 
    * - path
      - content
+   * - /.github
+     - Automated github action workflows
    * - /bin
      - Contains compiled binaries
    * - /data
      - Directory for flashing device filesystem
    * - /doc
      - Various external documents used as input
    * - /html
-     - Source for html files
-   * - /img
-     - Images uses in README.md
+     - Copy of gravitymon-ui (User Interface) build
    * - /lib
      - External libraries used when compiling
    * - /script
@@ -101,15 +108,23 @@ This is a list of C++ defines that is used to enable/disable functions in the co
 
    * - define
      - description
-   * - SKIP_SLEEPMODE
-     - The device never goes into sleep mode, useful when developing.
    * - USER_SSID
      - If defined the device will always use this SSID
    * - USER_SSID_PWD
      - Password to the SSID
+   * - LOG_LEVEL
+     - Defines the logging level used 4=INFO, 5=DEBUG, 6=VERBOSE
    * - CFG_APPVER
      - Defines the version of the compiled software
+   * - CFG_GITREV
+     - Contains the last 6 digits of the git revision
    * - USE_SERIAL_PINS
      - Will send the serial console to the TX/RX pins on an ESP32 target so that debugging can be done when on battery
    * - FLOATY
      - Build for the ESP32lite FLOATY hardware option (no DS18B20 and no battery monitor)
+   * - ENABLE_REMOTE_UI_DEVELOPMENT
+     - When enabled this will enable the UI project to interact with a device without any security issues, should not be enabled for production builds
+   * - SKIP_SLEEPMODE
+     - The device never goes into sleep mode, useful when developing
+   * - COLLECT_PERFDATA
+     - Used to send performance data to an influx database for analysis (development)

src_docs/source/conf.py

@@ -18,12 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'GravityMon'
-copyright = '2021-2023, Magnus Persson'
+copyright = '2021-2024, Magnus Persson'
 author = 'Magnus Persson'
 
 # The full version, including alpha/beta/rc tags
-release = '1.4.0'
-
+release = '2.0.0-alfa1'
 
 # -- General configuration ---------------------------------------------------
 
@@ -49,7 +48,7 @@
 #
 html_theme = 'furo'
 html_logo = "images/gravitymon_logo.png"
-html_title = "GravityMon v1.4.0"
+html_title = "GravityMon v2.0.0-alfa1"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,