Add Sphinx documentation

.gitignore

@@ -1,3 +1,5 @@
 # Build files
 /build/
-__pycache__/
+__pycache__/
+docs/build
+.idea

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,178 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain 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 = 'CyanoByte'
+copyright = '2019, CyanoByte Contributors'
+author = 'CyanoByte Contributors'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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.githubpages',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# 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 = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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 = 'alabaster'
+
+# 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 = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CyanoBytedoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'CyanoByte.tex', 'CyanoByte Documentation',
+     'CyanoByte Contributors', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'cyanobyte', 'CyanoByte Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'CyanoByte', 'CyanoByte Documentation',
+     author, 'CyanoByte', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------

docs/source/development/decision_log.rst

@@ -0,0 +1,2 @@
+Decision Log
+============

docs/source/development/index.rst

@@ -0,0 +1,13 @@
+Development Guide
+=================
+
+This is for notes relating to development of CyanoByte.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   style.rst
+   use_cases.rst
+   roadmap.rst
+   decision_log.rst

docs/source/development/roadmap.rst

@@ -0,0 +1,2 @@
+Roadmap
+=======

docs/source/development/style.rst

@@ -0,0 +1,2 @@
+Style
+=====

docs/source/development/use_cases.rst

@@ -0,0 +1,76 @@
+Use Cases
+=========
+
+The following document includes the master list of use cases that we are considering handling so that we can rank them in our roadmap. If you have a new use case that is not included in this document, feel free to add it.
+
+While this feels perhaps a bit unorthodox for an open source project, it is important that we take into consideration the many different users of the specification to allow for broad adoption.
+
+System Actors and Stakeholder
+-----------------------------
+
+The following is a list of system actors and system stakeholders of CyanoByte.
+
+Embedded Developers
+~~~~~~~~~~~~~~~~~~~
+
+It is expected that the primary users of the project are embedded developers. The CyanoByte specification creates a standardized format for datasheets so that the developer does not have to switch between many different formats. Additionally, it allows for code stubs to be created to more quickly develop firmware that uses a particular chip.
+
+Key Competitive Advantages:
+
+- Reduce the development time by automatically generating the non-application specific logic
+- Make reading datasheets more efficient by creating a standardized format and interface
+- More rapidly create proof-of-concepts using higher-level languages such as Python that can then be easily ported to embedded platforms
+
+Peripheral Chip Manufacturer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In order for the standard to become universally used, it is critical to get buy-in from manufacturers of electronic components. The CyanoByte specification can be used as both an internal tool during the development of a new peripheral that is formally defined and unambiguous as well as an external tool for developing datasheets and users guides. Additionally, by automatically generating example code in multiple programming languages for multiple platforms, the cost to create examples is greatly reduced.
+
+Key Competitive Advantages:
+
+- Reduce development time of code examples
+
+
+Microcontroller Manufacter
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The CyanoByte generators may be used by, created by, or maintained by microcontroller manufacturers. If enough peripherals are available, then maintaining a CyanoByte generator for a particular microcontroller given the manufacturer a competitive advantage as it makes development on their platform far quicker and easier than others.
+
+
+Electronics Hobbiest
+~~~~~~~~~~~~~~~~~~~~
+
+The electronics hobbyist market may be a key early user of the specification while it is under development.
+
+
+Data Scientists and Machine Learning Engineers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The CyanoByte specifications provide a new source of data that was not previously accessible before.
+
+Electronics Distributors
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The CyanoByte specifications provide a new source of information that can be used for novel parametric search tools. By using or creating specifications, distributors
+
+Examples:
+
+- DigiKey (https://www.digikey.com/)
+- Arrow (https://www.arrow.com/)
+- Mouser (https://www.mouser.com/)
+
+Electronic Computer Aided Design Tools (ECAD)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Creators of ECAD tools can use the CyanoByte specifications to provide better hardware in the
+
+Other Related Standards
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The scope of CyanoByte is intentionally limited to only embedded communications at the logical level. It does not take into account anything related to the electrical signals. Therefore it is expected that the CyanoByte standard should work in conjunction with other standards that may already or eventually exist.
+
+
+User Stories
+------------
+
+TODO

docs/source/generator/index.rst

@@ -0,0 +1,8 @@
+CyanoByte Generator
+===================
+
+This is the official documentation for the CyanoByte generator.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:

docs/source/index.rst

@@ -0,0 +1,25 @@
+.. CyanoByte documentation master file, created by
+   sphinx-quickstart on Sun Apr 28 14:38:12 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to CyanoByte's documentation!
+=====================================
+
+CyanoByte is a YAML based specification for formally defining embedded communications. It allows for both documentation and code to be generated from the CyanoByte files. The specification was greatly inspired by the successes of OpenAPI. 
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   development/index.rst
+   specification/index.rst
+   generator/index.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/specification/annotated_standards/index.rst

@@ -0,0 +1,4 @@
+Annotated Standard
+==================
+
+This section includes an annotated version of the standards that include the reasons why we made the decisions that we did.