Add files to follow Qwiic_Template.py

Author: makin-stuff

.readthedocs.yml

@@ -0,0 +1,5 @@
+python:
+   version: 3
+   install:
+      - requirements: docs/requirements.txt
+   setup_py_install: true

DESCRIPTION.rst

@@ -0,0 +1,5 @@
+Qwiic Alphanumeric Python Package
+=============================================
+
+This package controls individual segments of the 14-segment, alphanumeric displays.
+The user can print full strings, adjust brightness, and set the blink rate of their display.

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,5 @@
+API Reference
+==============
+
+.. automodule:: qwiic_alphanumeric
+   :members:

docs/_static/favicon.ico

@@ -0,0 +1,69 @@
+# 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:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 = 'sparkfun_qwiic_alphanumeric_py'
+copyright = '2021, SparkFun Electronics'
+author = 'SparkFun Electronics'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.01'
+
+
+# -- 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.intersphinx',
+	'sphinx.ext.viewcode',
+	'm2r2'
+	]
+
+source_suffix = ['.rst', '.md']
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+master_doc = 'index'
+# 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.
+#
+import sphinx_rtd_theme
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+
+# 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']
+
+html_favicon = '_static/favicon.ico'
+
+
+
+

docs/apiref.rst

@@ -0,0 +1,7 @@
+
+Example One - Begin
+---------------------------
+.. literalinclude:: ../examples/qwiic_alphanumeric_ex01_begin.py
+    :caption: examples/qwiic_alphanumeric_ex01_begin.py
+    :linenos:
+

docs/conf.py

@@ -0,0 +1,6 @@
+
+Example Ten - Scrolling String
+-----------------------------------
+.. literalinclude:: ../examples/qwiic_alphanumeric_ex10_scrolling_string.py
+    :caption: examples/qwiic_alphanumeric_ex10_scrolling_string.py
+    :linenos:

docs/ex1.rst

@@ -0,0 +1,6 @@
+
+Example Two - Turn on one Segment
+-----------------------------------
+.. literalinclude:: ../examples/qwiic_alphanumeric_ex02_turn_on_one_segment.py
+    :caption: examples/qwiic_alphanumeric_ex02_turn_on_one_segment.py
+    :linenos: