Merge pull request #24 from zacharytomlinson/chore-chore-chore-i-hate-my-life

A lot of nice stuff....

Author: zacharytomlinson

.github/ISSUE_TEMPLATE/bug.md

@@ -33,5 +33,11 @@ Write down what you thought would happen.
 
 - SASPy version used:
 - Python version used:
-- O.S. runing the code:
+- O.S. running the code:
 - VLT Vendor and Model:
+
+**Connection Method (check one please)**
+- [ ] Prolific USB Cable
+- [ ] Raspberry miniUART
+- [ ] RS-232 to TTL (Like MAX3323)
+- [ ] Other: <!-- Write here -->

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.12"
+    python: "3.10"
     # You can also specify other tool versions:
     # nodejs: "19"
     # rust: "1.64"
@@ -20,13 +20,13 @@ sphinx:
   configuration: docs/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#    - pdf
-#    - epub
+formats:
+   - pdf
+
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
    install:
-   - requirements: requirements.txt
+   - requirements: docs/requirements.txt

README.md

@@ -1,4 +1,6 @@
 # SASPY
+[![Documentation Status](https://readthedocs.org/projects/saspy/badge/?version=latest)](https://saspy.readthedocs.io/en/latest/?badge=latest)
+
 <p align="center">
 <img src="https://github.com/zacharytomlinson/saspy/assets/15037424/e8a8efc8-e83f-44f9-9ca1-7543a280e6b3" width="300" height="auto">
 </p>
@@ -10,7 +12,7 @@ This project, once reached a stable release, will be published on [PyPi](https:/
 # Documentation
 Since this library is still under heavy development (but at least is working !) comments are still not complete and there is a draft of documentation into `docs/` folder. 
 
-We are working hard to deliver also a readthedocs url.
+All the latest documentation regarding this library can be found on [Read The Docs](https://saspy.readthedocs.io/)
 
 In the meantime feel free to checkout the [WiKi of this project](https://github.com/zacharytomlinson/saspy/wiki) where you are gonna find response and solutions to common problems we faced during our journey
 

config.yml

@@ -2,10 +2,11 @@ connection:
   serial_port: /dev/ttyUSB0
   timeout: 2
   baudrate: 19200
+  infinite: False
 
 events:
-  poll_timeout: 0.2
-  poll_address: 0x80
+  poll_timeout: 0.5
+  poll_address: 0x82 # Standard Poll Address - On most the machines | Try 0x80 if 82 dont work
 
 debug:
   level: DEBUG #    CRITICAL | ERROR | WARNING | INFO | DEBUG | NOTSET
@@ -14,7 +15,7 @@ security:
   key: 44
 
 machine:
-  pos_id: B374A402
-  reg_key: 0000000000000000000000000000000000000000
-  asset_number: 01000000
+  pos_id: "B374A402"
+  reg_key: "0000000000000000000000000000000000000000"
+  asset_number: "15cd5b07" # Asset Magic Number - Works on every machine !
   denomination: 0.01

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -1,13 +1,58 @@
-# docs/conf.py
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# Add the following content
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
+
+# -- Project information -----------------------------------------------------
+
 project = 'SASPy'
-author = 'Zachary Tomlinson, Antonio D\'Angelo'
+copyright = "2024, Zachary Tomlinson, Antonio D'Angelo"
+author = "Zachary Tomlinson, Antonio D'Angelo"
+
+# The full version, including alpha/beta/rc tags
+release = '2.0.0'
+
+
+# -- General configuration ---------------------------------------------------
 
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
 extensions = [
     'sphinx.ext.autodoc',
-]
+    'sphinx.ext.coverage',
+    'sphinx.ext.napoleon'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/config.yml

@@ -1,20 +1,27 @@
-.. sas documentation master file, created by
-   sphinx-quickstart on Tue Jan 25 12:34:56 2024.
+Welcome to SASPy's documentation!
+===================================
 
-Welcome to the SASpy documentation!
-====================================
+.. image:: saspy-logo.jpeg
+   :align: center
+   :width: 300
 
-.. toctree::
-   :maxdepth: 2
+|
+| **SASPy** is a Python library for handling your beloved VLTs via SAS Protocol.
+
+At moment is compatible with SAS v6.02+
+
+Check out the :ref:`wiki-home`. section for more information about connections and common problems.
 
-   config_handler
-   error_handler
-   sas
-   models
+.. note::
+   This project is under active development.
 
-Indices and tables
-==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. toctree::
+   :maxdepth: 1
+   :caption: Table of Contents
+   :name: mastertoc
+   :glob:
+
+   Home <self>
+   Wiki <wiki/WikiHome>
+   The Library <sas-lib/main>