AT5-256: documention for CSP.LMC Common (first step).

## Description

General requirements for the monitor and control functionality are the same for both SKA Mid and Low 

telescopes.<br>

Two of three `CSP` Sub-elements, `PSS` and `PST`, have the same functionality and use the

same design in both telesopes.<br>

Functionality common to Low and Mid `CSP.LMC` includes:

* communication software

* logging

* archiving

* alarm generation

* sub-arraying

* some of the functionality related to handling observing mode

* Pulsar Search and Pulsar Timing.

The main differences between `Low` and `Mid` `CSP.LMC` are due to the different receivers and `CBF`

functionality and design.<br>

The `CSP.LMC Common Software` package provides the base software to develop the Low and Mid CSP.LMC.<br>

The `CSP.LMC` software is based on the `TANGO Control System`,the `SKA Control System Guidelines` and the `SKA CSP.LMC Base Classes`.

.. Documentation

CspMaster Class Documentation 

================================

.. automodule:: CspMaster

   :members:

   :undoc-members:

   :show-inheritance:

   :member-order:

#!/usr/bin/env python3

# -*- coding: utf-8 -*-

#

# developer.skatelescope.org documentation build configuration file, created by

# sphinx-quickstart on Wed Dec 13 11:59:38 2017.

# Configuration file for the Sphinx documentation builder.

#

# 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.

# 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 tango

import skabase

#autodoc_mock_imports = ['PyTango', 'tango', 'tango.server','run', 'DeviceMeta', 'command',

#                 'future', 'future.utils', 'logging', 'logging.handlers', 'skabase',

#                 'skabase.auxiliary', 'skabase.SKAMaster.SKAMaster', 'SKAMaster',

#                 'skabase.SKASubarray.SKASubarray', 'SKASubarray','numpy'

#                 ]

autodoc_member_order = 'bysource'

import os

import sys

sys.path.insert(0, os.path.abspath('../..'))

sys.path.insert(0, os.path.abspath('../../csp-lmc-common/csp-lmc-common'))

import sphinx_rtd_theme

def setup(app):

    app.add_stylesheet('css/custom.css')

    app.add_javascript('js/github.js')

# -- General configuration ------------------------------------------------

# -- Project information -----------------------------------------------------

project = 'CSP.LMC Common Software'

copyright = '2019, INAF - SKA Organization'

author = 'E.Giani'

# The short X.Y version

version = ''

# The full version, including alpha/beta/rc tags

release = '1.0.0'

# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.

#

# 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',

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',

              'recommonmark']

    'sphinx.ext.napoleon',

]

# 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'

# source_suffix = ['.rst', '.md']

source_suffix = '.rst'

# The master toctree document.

master_doc = 'index'

# General information about the project.

project = 'developer.skatelescope.org'

copyright = '2018, SKA Organization'

author = 'Marco Bartolini'

# 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.Z version.

version = '0.1.0'

# The full version, including alpha/beta/rc pre-release tags.

release = '0.1.0-beta'

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

#

# 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

# 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 = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.

todo_include_todos = True

# -- Options for HTML output ----------------------------------------------

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for

# a list of builtin themes.

# further.  For a list of options available for each theme, see the

# documentation.

#

html_theme_options = {

    #'logo_only' : False,

    #'logo_only' : 'ska_logo.jpg',

    #'logo' : 'ska_logo.jpg',

}

# html_theme_options = {}

html_context = {

    'favicon': 'img/favicon.ico',

    'logo': 'img/logo.jpg',

    'theme_logo_only' : True,

    'display_github': True, # Integrate GitHub

    'github_user': 'flyingfrog81', # Username

    'github_repo': 'developer.skatelescope.org', # Repo name

    'github_repo': 'csp-lmc', #Repository name

    'github_version': 'master',  #Version

    'conf_py_path': '/src/', # Path in the checkout to the docs root

    'conf_py_path': '/docs/src/', # Path in the checkout to the docs root

}

# 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',

#    ]

#}

# 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 ------------------------------------------

# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.

htmlhelp_basename = 'developerskatelescopeorgdoc'

htmlhelp_basename = 'CSPLMCdoc'

# -- Options for LaTeX output ---------------------------------------------

# -- Options for LaTeX output ------------------------------------------------

latex_elements = {

    # The paper size ('letterpaper' or 'a4paper').

# (source start file, target name, title,

#  author, documentclass [howto, manual, or own class]).

latex_documents = [

    (master_doc, 'developerskatelescopeorg.tex', 'developer.skatelescope.org Documentation',

     'Marco Bartolini', 'manual'),

    (master_doc, 'CSPLMC.tex', 'CSP.LMC Common Software Documentation',

     'SKA Organization', 'manual'),

]

# -- Options for manual page output ---------------------------------------

# -- 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, 'developerskatelescopeorg', 'developer.skatelescope.org Documentation',

    (master_doc, 'csplmc', 'CSP.LMC Common Software Documentation',

     [author], 1)

]

# -- Options for Texinfo output -------------------------------------------

# -- 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, 'developerskatelescopeorg', 'developer.skatelescope.org Documentation',

     author, 'developerskatelescopeorg', 'One line description of project.',

    (master_doc, 'CSPLMC', 'CSP.LMC Common Software Documentation',

     author, 'CSPLMCPrototype', 'One line description of project.',

     'Miscellaneous'),

]

# -- Options for Epub output ----------------------------------------------

# -- 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_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

.. skeleton documentation master file, created by

   sphinx-quickstart on Thu May 17 15:17:35 2018.

.. CSP LMC Prototype documentation master file, created by

   sphinx-quickstart on Thu Jun 13 16:15:47 2019.

   You can adapt this file completely to your liking, but it should at least

   contain the root `toctree` directive.

.. HOME SECTION ==================================================

.. Hidden toctree to manage the sidebar navigation.

.. toctree::

  :maxdepth: 2

  :caption: Home

  :hidden:

.. README =============================================================

.. This project most likely has it's own README. We include it here.

CSP LMC Prototype's documentation

=============================================

.. toctree::

   :maxdepth: 2

   :caption: Readme

   README

.. COMMUNITY SECTION ==================================================

..

.. toctree::

  :maxdepth: 2

  :caption: Package-name

  :hidden:

  package/guide

   :maxdepth: 1

   :caption: Contents:

Project-name documentation

==========================

   CspMaster<CspMaster>

These are all the packages, functions and scripts that form part of the project.

Indices and tables

==================

- :doc:`package/guide`

* :ref:`genindex`

* :ref:`modindex`

* :ref:`search`

.. doctest-skip-all

.. _package-guide:

.. todo::

    - Insert todo's here

**************************

Package-name documentation

**************************

This section describes requirements and guidelines.

Subtitle

========

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

.. Automatic API Documentation section. Generating the API from the docstrings. Modify / change the directory structure as you like

Public API Documentation

````````````````````````

Functions

---------

.. automodule:: ska_python_skeleton.ska_python_skeleton

    :members:

Classes

-------

.. autoclass:: ska_python_skeleton.ska_python_skeleton.SKA

    :noindex:

    :members: