Logging, more documentation

docs/source/conf.py

@@ -35,7 +35,7 @@ extensions = [
     'sphinx_rtd_theme'
 ]
 
-autodoc_mock_imports = ["smbus", "compLib.PCA9685", "RPi"]
+autodoc_mock_imports = ["smbus", "compLib.PCA9685", "RPi", "pigpio", "flask"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/source/lib/Api.rst

@@ -1,29 +1,29 @@
 .. _lib_api:
 
 Api
-=====
+****
 
 Seeding
-********
+========
 
 .. autoclass:: compLib.Api.Seeding
    :members:
 
 Double Elimination
-*******************
+===================
 
 .. autoclass:: compLib.Api.DoubleElim
    :members:
 
 Position
-*********
+========
 
 .. autoclass:: compLib.Api.Position
    :members:
 
 
 Examples
-*********
+========
 
 Calling Seeding API
 ---------------------

docs/source/lib/Battery.rst

@@ -1,20 +1,20 @@
 .. _lib_battery:
 
 Battery
-########
+********
 
 Class Documentation
-********************
+====================
 
 .. autoclass:: compLib.Battery.Battery
    :members:
 
 
 Examples
-*********
+=========
 
 Printing percentage
-====================
+--------------------
 
 .. code-block:: python
 

docs/source/lib/Buzzer.rst

@@ -1,19 +1,19 @@
 .. _lib_buzzer:
 
 Buzzer
-#######
+*******
 
 Class Documentation
-********************
+====================
 
 .. autoclass:: compLib.Buzzer.Buzzer
    :members:
 
 Examples
-*********
+=========
 
 Turning buzzer on and off
-==========================
+--------------------------
 
 .. code-block:: python
 

docs/source/lib/IRSensor.rst

@@ -1,7 +1,7 @@
 .. _lib_irsensor:
 
 Infrared Sensor
-================
+****************
 
 .. autoclass:: compLib.IRSensor.IRSensor
    :members:

docs/source/lib/Logging.rst

@@ -0,0 +1,22 @@
+.. _lib_logging:
+
+Logging
+*******
+
+Class Documentation
+====================
+
+.. autoclass:: compLib.LogstashLogging.Logging
+   :members:
+
+Examples
+=========
+
+Turn up the logging
+--------------------
+
+.. code-block:: python
+
+    from compLib.LogstashLogging import Logging
+
+    Logging.set_debug()

docs/source/lib/Motor.rst

@@ -1,19 +1,19 @@
 .. _lib_motor:
 
 Motor
-######
+******
 
 Class Documentation
-********************
+====================
 
 .. autoclass:: compLib.Motor.Motor
    :members:
 
 Examples
-*********
+=========
 
 Driving straight (maybe)
-=========================
+-------------------------
 
 .. code-block:: python
 

docs/source/lib/Servo.rst

@@ -1,7 +1,7 @@
 .. _lib_servo:
 
 Servo
-=====
+******
 
 .. autoclass:: compLib.Servo.Servo
    :members:

docs/source/lib/Vision.rst

@@ -1,7 +1,7 @@
 .. _lib_vision:
 
 Vision
-=====
+*******
 
 This module provides an interface for grabbing an rtmp stream and using the images to do some processing in opencv.
 
@@ -13,7 +13,7 @@ How do I use this module?
 4. You can view the http stream of your processed images in a web browser
 
 Opencv Stream
-*************
+==============
 
 Because of the rtmp stream needing to buffer some frames and waiting for P-Frames, importing this module might take up
 to 5 Seconds.
@@ -22,10 +22,10 @@ to 5 Seconds.
    :members:
 
 Examples
-*********
+=========
 
 Using the Vision Module
----------------------
+-------------------------
 
 .. code-block:: python