AT5-370: Updated documentation inside subelement_master.py. (d0f83e77) · Commits · Gianluca Marotta / csp-lmc-subelement-old

cspse/lmc/subelement_master.py

+30 −29

Original line number	Diff line number	Diff line
		@@ -108,7 +108,9 @@ class CspSubElementMaster(SKAMaster):
		dtype=AdminMode,
		access=AttrWriteType.READ_WRITE,
		memorized=True,
		doc="The admin mode reported for this device. It may interpret the current device condition \nand condition of all managed devices to set this. Most possibly an aggregate attribute.",
		doc=("The admin mode reported for this device. It may interpret the current"
		" device condition and condition of all managed devices to set this."
		" Most possibly an aggregate attribute."),
		)

		onCommandProgress = attribute(
		@@ -117,7 +119,9 @@ class CspSubElementMaster(SKAMaster):
		abs_change=10,
		max_value=100,
		min_value=0,
		doc="Percentage progress implemented for commands that result in state/mode transitions for a large \nnumber of components and/or are executed in stages (e.g power up, power down)",
		doc=("Percentage progress implemented for commands that result in state/mode"
		" transitions for a large number of components and/or are executed in "
		"stages (e.g power up, power down)"),
		)

		offCommandProgress = attribute(
		@@ -126,7 +130,9 @@ class CspSubElementMaster(SKAMaster):
		abs_change=10,
		max_value=100,
		min_value=0,
		doc="Percentage progress implemented for commands that result in state/mode transitions for a large \nnumber of components and/or are executed in stages (e.g power up, power down)",
		doc=("Percentage progress implemented for commands that result in state/mode transitions"
		" for a large number of components and/or are executed in stages"
		" (e.g power up, power down)"),
		)

		standbyCommandProgress = attribute(
		@@ -135,7 +141,9 @@ class CspSubElementMaster(SKAMaster):
		abs_change=10,
		max_value=100,
		min_value=0,
		doc="Percentage progress implemented for commands that result in state/mode transitions for a large \nnumber of components and/or are executed in stages (e.g power up, power down)",
		doc=("Percentage progress implemented for commands that result in state/mode"
		" transitions for a large number of components and/or are executed in"
		" stages (e.g power up, power down)"),
		)

		onCmdDurationExpected = attribute(
		@@ -513,14 +521,10 @@ class CspSubElementMaster(SKAMaster):
		by some tango device drivers which actas as 'cache'. We call these devices
		'racks', even if they can contro a different phisical arrangement.

		:param argin: 'DevVarStringArray'
		The list of sub-element components FQDNs to switch-on or an empty list to switch-on the whole
		CSP Sub-element.

		If the array length is 0, the command applies to the whole CSP Sub-Element. If the
		array length is > 1, each array element specifies the FQDN of the
		CSP SubElement component to switch ON.

		:param argin: The list of sub-element components FQDNs: if the array length is 0 (empty input \
		list), the command applies to the whole CSP Sub-Element. If the array length is > 1, \
		each array element specifies the FQDN of the CSP SubElement component to switch ON.
		:type: 'DevVarStringArray'
		:return: None
		"""
		pass
		@@ -547,12 +551,11 @@ class CspSubElementMaster(SKAMaster):
		'racks', even if they can contro a different phisical arrangement.


		:param argin: 'DevVarStringArray'
		If the array length is 0, the command applies to the whole
		CSP Sub-element.
		If the array length is > 1, each array element specifies the FQDN of the
		CSP SubElement component to switch OFF.

		:param argin: The list of sub-element components FQDNs: if the array length is 0 (no list \
		specified), the command applies to the whole CSP sub-element. If the array length \
		is > 1, each array element specifies the FQDN of a CSP SubElement component to switch \
		off.
		:type: 'DevVarStringArray'
		:return: None
		"""
		pass
		@@ -574,12 +577,11 @@ class CspSubElementMaster(SKAMaster):
		Transit the CSP Sub-element or one or more CSP SubElement components from ON/OFF to
		STANDBY.

		:param argin: 'DevVarStringArray'
		If the array length is 0, the command applies to the whole
		CSP sub-element.
		If the array length is > 1, each array element specifies the FQDN of the
		CSP SubElement icomponent to put in STANDBY mode.

		:param argin: The list of sub-element components FQDNs: if the array length is 0 (no list \
		specified), the command applies to the whole CSP sub-element. If the array length \
		is > 1, each array element specifies the FQDN of a CSP SubElement component to put \
		in STANDBY mode.
		:type: 'DevVarStringArray'
		:return: None
		"""
		pass
		@@ -591,7 +593,6 @@ class CspSubElementMaster(SKAMaster):
		def Upgrade(self):
		# PROTECTED REGION ID(CspSubElementMaster.Upgrade) ENABLED START #
		"""

		:return: None
		"""
		pass

docs/src/conf.py

+10 −10

Original line number	Diff line number	Diff line
		@@ -17,9 +17,9 @@
		# 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.
		#
		autodoc_mock_imports = ['PyTango', 'tango', 'tango.server','run', 'DeviceMeta', 'command',
		autodoc_mock_imports = ['PyTango', 'tango', 'tango.server','run', 'command',
		'future', 'future.utils', 'logging', 'logging.handlers', 'ska',
		'ska.base', 'SKAMaster', 'SKASubarray','numpy',
		'ska.base', 'ska.base.control_model', 'SKAMaster', 'SKASubarray','numpy',
		'csp_lmc_common'
		]
		autodoc_member_order = 'bysource'
		@@ -28,7 +28,6 @@ import os
		import sys
		sys.path.insert(0, os.path.abspath('../../'))
		import sphinx_rtd_theme

		def setup(app):
		app.add_stylesheet('css/custom.css')
		app.add_javascript('js/github.js')
		@@ -52,7 +51,8 @@ extensions = ['sphinx.ext.autodoc',
		'sphinx.ext.ifconfig',
		'sphinx.ext.viewcode',
		'sphinx.ext.githubpages',
		'recommonmark']
		'recommonmark'
		]

		# Add any paths that contain templates here, relative to this directory.
		templates_path = ['_templates']
		@@ -69,7 +69,7 @@ master_doc = 'index'
		# General information about the project.
		project = 'Csp:LMC Subelement Classes'
		copyright = '2020, INAF-SKA Organization'
		author = 'E.Giani'
		author = 'C.Baffa, E.Giani'

		# The version info for the project you're documenting, acts as replacement for
		# \|version\| and \|release\|, also used in various other places throughout the
		@@ -179,8 +179,8 @@ latex_elements = {
		# (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, 'CspLMCSubElement.tex', 'CSP.LMC Subelement TANGO Classes Documentation',
		'SKA Organization', 'manual'),
		]


		@@ -189,7 +189,7 @@ latex_documents = [
		# 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-subelement', 'CSP.LMC Subelement TANGO Classes Documentation',
		[author], 1)
		]

		@@ -200,8 +200,8 @@ man_pages = [
		# (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, 'CSP.LMC-SubElement', 'CSP.LMC Subelement TANGO Classes Documentation',
		author, 'CSP.LMC-SubElement', 'One line description of project.',
		'Miscellaneous'),
		]

docs/src/index.rst

+1 −1

Original line number	Diff line number	Diff line
		@@ -30,7 +30,7 @@

		.. toctree::
		:maxdepth: 2
		:caption: Package name
		:caption: Csp.LMC SubElement TANGO Classes
		:hidden:

		package/guide

docs/src/package/guide.rst

+10 −22

Original line number	Diff line number	Diff line
		@@ -5,32 +5,20 @@
		- write documentation for private and protected attributes and methods of
		the CSP.LMC Subelement classes.

		*****************************************
		CSP.LMC Subelement Classes documentation
		*****************************************
		************************
		Public API documentation
		************************


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

		Public API Documentation
		````````````````````````
		Functions
		---------

		CspSubElementMaster TANGO Class
		--------------------------------
		.. automodule:: cspse.lmc.subelement_master
		:members:
		:member-order:

		CspSubElementMaster Class
		-------------------------
		.. autoclass:: cspse.lmc.subelement_master.CspSubElementMaster
		:noindex:
		:members:

		CspSubElementSubarray Class
		---------------------------
		.. autoclass:: cspse.lmc.subelement_master.CspSubElementMaster
		:noindex:
		:members:

		CspSubElementSubarray Class
		---------------------------
		CspSubElementSubarray TANGO Class
		---------------------------------
		.. todo::
		- write documentation for CSP.LMC SubElementSubarray Class