docs: Add initial structure for documentation

Use Sphinx to for documenting the project.
Signed-off-by: default avatarEnric Balletbo i Serra <enric.balletbo@collabora.com>
parent ef8c029e
# 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)
# -*- 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 = 'Chromebooks Test Suite'
copyright = '2019, Fabien Lahoudere and Enric Balletbo'
author = 'Fabien Lahoudere and Enric Balletbo'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.1'
# -- 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.ifconfig',
'sphinx.ext.viewcode',
]
# 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'
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd: # only import and set the theme if we're building docs locally
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']
# 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 = 'ChromebooksTestSuitedoc'
# -- 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, 'ChromebooksTestSuite.tex', 'Chromebooks Test Suite Documentation',
'Fabien Lahoudere and Enric Balletbo', '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, 'chromebookstestsuite', 'Chromebooks Test Suite 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, 'ChromebooksTestSuite', 'Chromebooks Test Suite Documentation',
author, 'ChromebooksTestSuite', '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 -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
*******************
Authors and Credits
*******************
Crostests Project Coordinators
==============================
* Fabien Lahoudere
* Enric Balletbo i Serra
******************
Testing Guidelines
******************
.. Chromebooks Test Suite documentation master file, created by
sphinx-quickstart on Fri Dec 20 14:19:08 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
:tocdepth: 3
####################################
Chromebooks Test Suite Documentation
####################################
The ``crostests`` package is a framework for fully automated testing. It is
designed primarily to test the Linux Kernel under KernelCI with the main focus
on Chromebooks devices.
``crostests`` is composed of a number of modules that will help you to do stand
alone tests or setup a fully automated test on KernelCI, depending on what you
are up to.
.. _getting-started:
***************
Getting Started
***************
.. toctree::
:maxdepth: 1
install
.. _user-docs:
******************
User Documentation
******************
.. toctree::
:maxdepth: 1
testcases
testhelpers
testrunners
.. _developer-docs:
***********************
Developer Documentation
***********************
The developer documentation contains instructions for how to contribute to
the Chromebook tests or affiliated packages, as well as coding, documentation,
and testing guidelines.
.. toctree::
:maxdepth: 1
development/testguide
.. _project-details:
***************
Project details
***************
.. toctree::
:maxdepth: 1
credits
license
******************
Indices and tables
******************
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
************
Installation
************
Requirements
============
********
Licenses
********
.. include:: ../../LICENSE
**********
Test Cases
**********
A test case is a set of conditions or variables under which a tester will
determine whether an application or system is working correctly. It may take
many test cases to determine that a software program or system is considered
sufficiently scrutinized to be released. Test cases are often referred to as
test scripts, particularly when written. Written test cases are usually
collected into test suites.
cros-ec-accel
=============
.. automodule:: tests.cros_ec_accel
:members:
cros-ec-extcon
==============
.. automodule:: tests.cros_ec_extcon
:members:
cros-ec-gyro
============
.. automodule:: tests.cros_ec_gyro
:members:
cros-ec-mcu
===========
.. automodule:: tests.cros_ec_mcu
:members:
cros-ec-power
=============
.. automodule:: tests.cros_ec_power
:members:
cros-ec-pwm
===========
.. automodule:: tests.cros_ec_pwm
:members:
cros-ec-rtc
===========
.. automodule:: tests.cros_ec_rtc
:members:
************
Test Helpers
************
kernel
======
.. automodule:: helpers.kernel
:members:
mcu
===
.. automodule:: helpers.mcu
:members:
sysfs
=====
.. automodule:: helpers.sysfs
:members:
************
Test Runners
************
A Test Runner is used to execute the test suite and show the result. With a
Test Runner, you can easily:
* Run automatic, semi-automatic and manual test cases and test suites.
* Follow the results in real time.
* Run only the needed test cases.
* Change the execution order of test cases.
LAVA Test Runner
----------------
.. automodule:: runners.lava_runner
:members:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment