docs: started adding sphinx documentation

2b30d6dd · Milosz Malczak · a4e54a4f · 2b30d6dd · 2b30d6dd · 2b30d6dd
Commit 2b30d6dd authored Jul 26, 2019 by Milosz Malczak
11 changed files
--- a/documentation/sphinx/Makefile
+++ b/documentation/sphinx/Makefile
+# Minimal makefile for Sphinx documentation
+#
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = distributed_oscilloscope
+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)
\ No newline at end of file
--- a/documentation/sphinx/conf.py
+++ b/documentation/sphinx/conf.py
+# -*- coding: utf-8 -*-
+#
+# distributed_oscilloscope documentation build configuration file, created by
+# sphinx-quickstart on Fri Jul 26 10:04:12 2019.
+#
+# 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.
+soft_dir = '/home/milosz/Projects/distributed_oscilloscope/software/'
+import os
+import sys
+sys.path.append(os.path.abspath(soft_dir + 'pyqt_app'))
+sys.path.append(os.path.abspath(soft_dir + 'server'))
+sys.path.append(os.path.abspath(soft_dir + 'fec'))
+sys.path.append(os.path.abspath(soft_dir))
+print(sys.path)
+# -- 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',
+    '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 = u'distributed_oscilloscope'
+copyright = u'2019, Milosz Malczak'
+author = u'Milosz Malczak'
+# 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 = u'1'
+# The full version, including alpha/beta/rc tags.
+release = u'0'
+# 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 = 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'
+# 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.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+# -- Options for HTMLHelp output ------------------------------------------
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'distributed_oscilloscopedoc'
+# -- 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, 'distributed_oscilloscope.tex', u'distributed\\_oscilloscope Documentation',
+     u'Milosz Malczak', '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, 'distributed_oscilloscope', u'distributed_oscilloscope 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, 'distributed_oscilloscope', u'distributed_oscilloscope Documentation',
+     author, 'distributed_oscilloscope', 'One line description of project.',
+     'Miscellaneous'),
+]
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+html_theme = 'sphinx_rtd_theme'
+numfig = True
--- a/documentation/sphinx/devices.rst
+++ b/documentation/sphinx/devices.rst
+.. _devices:
+Devices
+======
--- a/documentation/sphinx/graphics/problem_description.pdf
+++ b/documentation/sphinx/graphics/problem_description.pdf
--- a/documentation/sphinx/graphics/problem_description.png
+++ b/documentation/sphinx/graphics/problem_description.png
--- a/documentation/sphinx/index.rst
+++ b/documentation/sphinx/index.rst
+.. distributed_oscilloscope documentation master file, created by
+   sphinx-quickstart on Fri Jul 26 10:04:12 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+Welcome to distributed_oscilloscope's documentation!
+====================================================
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   introduction
+   installation
+   usage
+   user_applications
+   devices 
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
--- a/documentation/sphinx/installation.rst
+++ b/documentation/sphinx/installation.rst
+.. _installation:
+Installation
+===========
--- a/documentation/sphinx/introduction.rst
+++ b/documentation/sphinx/introduction.rst
+.. _introduction:
+-----------
+Introduction
+-----------
+The Distributed Oscilloscope (DO) is an application allowing to synchronously monitor analog signals in a distributed system, independently of the distance.
+The idea of the DO is presented in :numref:`fig-problem-description`.
+.. figure:: graphics/problem_description.png
+   :name: fig-problem-description
+   :width: 400pt
+   :align: center
+   :alt: alternate text
+   :figclass: align-center
+   Synchronous acqusition of distributed data 
+Analog signals from various digitizers are time-stamped, aligned to the same moment in time and sent to the Graphical User Interfacei (GUI), to be displayed. The synchronization is obtained using the White Rabbit Trigger Distribution `(WRTD)  <https://www.ohwr.org/project/wrtd>`_ project.
+Architecture
+===========
+The DO constits of three layers:
+* `User Application`_
+* `Server`_
+* `Device Application`_
+================
+`User Application`_
+================
+There are currently two User Applications available:
+* GUI --- it is designed to resemble standard oscilloscope.
+* testbench --- it is used to test the Server and the Device Applications as well as to perform statistical measurements of data acquisition speed and of the precision of the synchronization.
+The User Applications serve two purposes:
+* Deviced configuration
+* Collecting and processing the acquisition data
+The Device Applications never communicate with the devices directly, always through the Server. This allows to hide all the implementation details and to provide common interface for various types of applications. 
+The details how to write User Applications are described in section :ref:`user_applications`
+================
+`Server`_
+================
+The Server is a central unit responsible for managing all the connections, preprocessing the data and providing a common interface for connected applications. 
+================
+`Device Application`_
+================
--- a/documentation/sphinx/server.rst
+++ b/documentation/sphinx/server.rst
+.. _server:
+Server Application
+==================
+.. automodule:: connection_manager 
+.. autoclass:: ConnectionManager 
--- a/documentation/sphinx/usage.rst
+++ b/documentation/sphinx/usage.rst
+.. _usage:
+Usage of the GUI
+================
--- a/documentation/sphinx/user_applications.rst
+++ b/documentation/sphinx/user_applications.rst
+.. _user_applications:
+User Applications
+=========================