doc: add initial documentation

Add initial minimal documentation to setup a readthedocs instance for
labgridhelper.

Signed-off-by: Rouven Czerwinski <[email protected]>

Author: Emantor

doc-requirements.txt

@@ -0,0 +1,3 @@
+Sphinx==1.8.1
+sphinx_rtd_theme==0.4.1
+docutils==0.14

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+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/conf.py

@@ -0,0 +1,192 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# labgrid documentation build configuration file, created by
+# sphinx-quickstart on Mon Feb 20 10:00:00 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('..'))
+
+from pkg_resources import get_distribution
+
+# Import read_the_docs theme
+import sphinx_rtd_theme
+
+# -- 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.napoleon',
+              'sphinx.ext.coverage',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.autosectionlabel']
+
+# 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 = 'labgridhelper'
+copyright = '2019 Pengutronix, Jan Luebbe and Rouven Czerwinski'
+author = 'Rouven Czerwinski'
+
+# 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 full version, including alpha/beta/rc tags.
+release = get_distribution('labgridhelper').version
+# The short X.Y version.
+version = '.'.join(release.split('.')[:2])
+
+# 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 = ['.build', 'Thumbs.db', '.DS_Store']
+
+# 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 = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# Set correct html_path for 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 = []
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'labgriddoc'
+
+
+# -- 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, 'labgridhelper.tex', 'labgridhelper Documentation',
+     author, '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, 'labgridhelper', 'labgridhelper 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, 'labgridhelper', 'labgridhelper Documentation',
+     author, 'labgrid', 'Helper functions for the labgrid library',
+     'Miscellaneous'),
+]
+
+
+# -- Options for autodoc --------------------------------------------------
+
+autodoc_member_order = 'bysource'
+autodoc_default_flags = ['special-members']
+autodoc_mock_imports = ['labgrid',
+			'labgrid.driver',
+			'labgrid.protocol']
+
+# -- Options for autosection ----------------------------------------------
+autosectionlabel_prefix_document = True
+
+
+from unittest.mock import Mock
+for mod in autodoc_mock_imports:
+    sys.modules[mod] = Mock()
+
+def run_apidoc(app):
+    from sphinx.apidoc import main
+    module = os.path.abspath(os.path.join(app.srcdir, '..', 'labgridhelper'))
+    output = os.path.abspath(os.path.join(app.srcdir, 'modules'))
+    cmd = ['sphinx-apidoc', module, '-M', '-H', 'Modules', '-o', output]
+    main(cmd)
+
+def setup(app):
+    app.connect('builder-inited', run_apidoc)

doc/index.rst

@@ -0,0 +1,22 @@
+Welcome to labgridhelper's documentation!
+===================================
+
+Labgridhelper provides utility functions for the labgrid library and labgrid
+testsuites.
+
+It is meant to provide wrapper functions for commonly used functionality such as
+the retrieval of the system service status information.
+
+.. toctree::
+   overview
+   modules/modules
+   :maxdepth: 2
+   :caption: Contents
+
+
+Indices and Tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/modules/labgridhelper.rst

@@ -0,0 +1,28 @@
+labgridhelper package
+=====================
+
+.. automodule:: labgridhelper
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+labgridhelper.barebox module
+----------------------------
+
+.. automodule:: labgridhelper.barebox
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+labgridhelper.linux module
+--------------------------
+
+.. automodule:: labgridhelper.linux
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+

doc/modules/modules.rst

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

doc/overview.rst

@@ -0,0 +1,43 @@
+==========
+ Overview
+==========
+
+Labgridhelper is separated into different submodules. These submodules are
+created for different stages of a device boot, i.e. the barebox submodules is
+used for the barebox bootloader and the linux submodule is used for a fully
+booted linux system.
+
+Writing new helper functions
+============================
+Helper functions usually use one of the protocols from labgrid to retrive data
+from the device, reformat the data and return it to be consumed in the test
+case.
+These functions should not perform test asserts, this should be done in the
+individual test cases, to separate data reformating from testing.
+Asserts however are needed to verify that the correct protocol is passed to the
+helper function. This is usually done by importing the protocol from labgrid and
+performing the assert in the beginning of the helper, i.e.:
+
+::
+
+  def get_systemd_status(command):
+      assert isinstance(command, CommandProtocol), "command must be a CommandProtocol"
+
+This should ensure that the correct protocol is used and the helper function is
+used correctly in the test suite.
+
+Helper functions should also contain a docstring to document its function for
+the user, i.e.:
+
+::
+
+  def get_commands(command, directories=None):
+      """Returns the commands of a running linux system
+
+      Args:
+          command (CommandProtocol): An instance of a Driver implementing the CommandProtocol
+          directories (list): An optional list of directories to include
+
+      Returns:
+          list: list of commands available under linux
+      """