Add documentation

Makefile

@@ -15,11 +15,10 @@ dev-pyenv:
 #######################################
 doc-update-refs:
 	rm -rf doc/source/refs/
-	sphinx-apidoc -M -f -e -o doc/source/refs/ tuxeatpi/
+	sphinx-apidoc -M -f -e -o doc/source/refs/ tuxeatpi_common/
 
 doc-generate:
 	cd doc && make html
-	touch doc/build/html/.nojekyll
 
 #######################################
 ### Localization

README.rst

@@ -8,3 +8,7 @@ TuxEatPi common python library
 
 .. |build| image:: https://circleci.com/gh/TuxEatPi/common.svg?style=svg
     :target: https://circleci.com/gh/TuxEatPi/common
+
+.. |docs| image:: https://readthedocs.org/projects/tuxeatpi-common/badge/?version=latest
+    :target: http://tuxeatpi-common.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = TuxEatPiCommon
+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)

doc/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=TuxEatPiCommon
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.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

doc/source/_static/css/custom.css

@@ -0,0 +1,7 @@
+div.section {
+    opacity: 1; 
+}
+
+div.mermaid * .section {
+    opacity: 0.4; 
+}

doc/source/conf.py

@@ -0,0 +1,210 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# TuxEatPi Common documentation build configuration file, created by
+# sphinx-quickstart on Sun Aug 20 21:06:08 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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('.'))
+
+
+# -- 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.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.mermaid',
+    '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'
+
+# General information about the project.
+project = 'TuxEatPi Common'
+copyright = '2017, TuxEatPi Team'
+author = 'TuxEatPi Team'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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 patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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'
+import sphinx_rtd_theme
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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']
+def setup(app):
+    app.add_stylesheet('css/custom.css')
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TuxEatPiCommondoc'
+
+
+# -- 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, 'TuxEatPiCommon.tex', 'TuxEatPi Common Documentation',
+     'TuxEatPi Team', '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, 'tuxeatpicommon', 'TuxEatPi Common 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, 'TuxEatPiCommon', 'TuxEatPi Common Documentation',
+     author, 'TuxEatPiCommon', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# 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']
+
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

doc/source/index.rst

@@ -0,0 +1,21 @@
+.. TuxEatPi Common documentation master file, created by
+   sphinx-quickstart on Sun Aug 20 21:06:08 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to TuxEatPi Common's documentation!
+===========================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    refs/modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/refs/modules.rst

@@ -0,0 +1,7 @@
+tuxeatpi_common
+===============
+
+.. toctree::
+   :maxdepth: 4
+
+   tuxeatpi_common

doc/source/refs/tuxeatpi_common.cli.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.cli module
+============================
+
+.. automodule:: tuxeatpi_common.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/refs/tuxeatpi_common.daemon.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.daemon module
+===============================
+
+.. automodule:: tuxeatpi_common.daemon
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/refs/tuxeatpi_common.dialogs.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.dialogs module
+================================
+
+.. automodule:: tuxeatpi_common.dialogs
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/refs/tuxeatpi_common.error.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.error module
+==============================
+
+.. automodule:: tuxeatpi_common.error
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/refs/tuxeatpi_common.initializer.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.initializer module
+====================================
+
+.. automodule:: tuxeatpi_common.initializer
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/refs/tuxeatpi_common.intents.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.intents module
+================================
+
+.. automodule:: tuxeatpi_common.intents
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/refs/tuxeatpi_common.memory.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.memory module
+===============================
+
+.. automodule:: tuxeatpi_common.memory
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/refs/tuxeatpi_common.message.rst

@@ -0,0 +1,7 @@
+tuxeatpi\_common\.message module
+================================
+
+.. automodule:: tuxeatpi_common.message
+    :members:
+    :undoc-members:
+    :show-inheritance: