Resolves "Documentation Update" (#189)

* Updated examples to use new string for printing

* updated module documentation to reflect new PyNeoDeviceEx

* Updated documentation

---------

Signed-off-by: David Rebbe <drebbe@intrepidcs.com>

Author: drebbe-intrepid

IntrepidCS.png

@@ -26,6 +26,21 @@ Python wrapper for interfacing to IntrepidCS Hardware.
 - Mac builds use [libicsneo](https://github.com/intrepidcs/libicsneo) and are built using cibuildwheel
 - libicsneolegacy.dylib is bundled with the wheel and python_ics will automatically use it.
 
+# Basic usage
+
+```python
+import ics
+
+devices = ics.find_devices()
+print(f"Found {len(devices)} devices...")
+for device in devices:
+    # Print, open, load default settings, close
+    print(device)
+    device.open()
+    device.load_default_settings()
+    device.close()
+```
+
 # Documentation
 
 http://python-ics.readthedocs.io/
@@ -35,6 +50,7 @@ http://python-ics.readthedocs.io/
 
 - Building from source requires clang and clang-format to be present on the build machine.
 - python_ics has submodules, please be sure to initial all submodules also.
+
 ```powershell
 PS > git clone git@github.com:intrepidcs/python_ics.git
 

README.md

@@ -1 +1,4 @@
-cython>=0.20
+cython>=0.20
+m2r2
+docutils>=0.18.1,<0.21
+furo

doc/requirements.txt

@@ -33,13 +33,14 @@
 extensions = [
     "sphinx.ext.autosummary",
     "sphinx.ext.autodoc",
+    "m2r2",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = ".rst"
+source_suffix = [".rst", ".md"]
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
@@ -103,13 +104,14 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-# html_theme = 'sphinx_rtd_theme'
-html_theme = "classic"
+#html_theme = 'sphinx_rtd_theme'
+#html_theme = "classic"
+html_theme = "furo"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {"body_max_width": "80%"}
+#html_theme_options = {"body_max_width": "80%"}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []

doc/source/conf.py

@@ -1,18 +1,18 @@
-============================================================
+##############################################################################
 Examples
-============================================================
+##############################################################################
 
 Examples can be found at https://github.com/intrepidcs/python_ics/tree/master/examples
 
 For extra information on data structures and underlying functionality, please visit neoVI DLL Documentation under https://intrepidcs.com/support/support-resources/
 
 Opening a device
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==============================================================================
 
 The ``open_device_example.py`` example shows how to successfully open and close an Intrepid device.
 
 Transmitting and Receiving a CAN message
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==============================================================================
 
 The following examples show how to interact with CAN messages on an Intrepid device.
 
@@ -22,7 +22,7 @@ The following examples show how to interact with CAN messages on an Intrepid dev
 
 
 ISO 15765-2 Example
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==============================================================================
 
 The ``iso15765_example.py`` example shows how to setup basic ISO 15765-2 receive filters and transmitting an ISO 15765-2 message.
 
@@ -34,6 +34,6 @@ Similarly transmitting an ISO 15765-2 frame can be accomplished by passing a cus
 
 
 Missing an example?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==============================================================================
 
 Need an example on something that isn't covered here? Please submit an issue on github or feel free to send over a Pull Request of your own.

doc/source/examples.rst

@@ -44,37 +44,44 @@ def generate_variables():
 
 def generate_documentation():
     return inspect.cleandoc(
-        """.. include:: header.rst
+        f""".. include:: header.rst
     .. include:: examples.rst
 
-    ============================================================
+    ##############################################################################
+    PyNeoDeviceEx
+    ##############################################################################
+    .. autoclass:: ics.PyNeoDeviceEx
+        :members:
+        :show-inheritance:
+        :undoc-members:
+
+    ##############################################################################
     Module Documentation
-    ============================================================
+    ##############################################################################
     .. automodule:: ics.ics
         :members:
         :show-inheritance:
         :undoc-members:
 
-    ============================================================
+    ##############################################################################
     Module Functions
-    ============================================================
+    ##############################################################################
 
-    %s
+    {generate_functions()}
 
-    ============================================================
+    ##############################################################################
     Module Structures
-    ============================================================
+    ##############################################################################
 
-    %s
+    {generate_structures()}
 
-    ============================================================
+    ##############################################################################
     Module Variables
-    ============================================================
+    ##############################################################################
 
-    %s
+    {generate_variables()}
 
     """
-        % (generate_functions(), generate_structures(), generate_variables())
     )