Skip to content
Snippets Groups Projects
Commit 8147edce authored by Aditya Dange's avatar Aditya Dange
Browse files

Fix documentation issue. Documents gets generated locally.

parent bd1e76c7
No related branches found
No related tags found
No related merge requests found
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA AlarmHandler
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKAAlarmHandler.SKAAlarmHandler
:members:
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA BaseDevice
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKABaseDevice.SKABaseDevice
:members:
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA Capability
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKACapability.SKACapability
:members: SKACapability
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA Logger
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKALogger.SKALogger
:members: SKALogger
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA Master
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKAMaster.SKAMaster
:members: SKAMaster
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA ObsDevice
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKAObsDevice.SKAObsDevice
:members:
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA Subarray
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKASubarray.SKASubarray
:members: SKASubarray
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA TelState
============================================
.. toctree::
:maxdepth: 2
.. automodule:: SKATelState.SKATelState
:members: SKATelState
...@@ -12,20 +12,25 @@ ...@@ -12,20 +12,25 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys # import sys
import os # import os
from mock import Mock as MagicMock # from mock import Mock as MagicMock
#
class Mock(MagicMock): # class Mock(MagicMock):
@classmethod # @classmethod
def __getattr__(cls, name): # def __getattr__(cls, name):
return MagicMock() # return MagicMock()
#
# # Mock tango modules
# MOCK_MODULES = ['PyTango', 'tango', 'tango.server', 'run', 'DeviceMeta', 'command',
# 'future', 'future.utils', 'logging', 'logging.handlers']
# sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
# Mock tango modules autodoc_mock_imports = ['PyTango', 'tango', 'tango.server', 'run', 'DeviceMeta', 'command',
MOCK_MODULES = ['PyTango', 'tango', 'tango.server', 'run', 'DeviceMeta', 'command',
'future', 'future.utils', 'logging', 'logging.handlers'] 'future', 'future.utils', 'logging', 'logging.handlers']
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
......
...@@ -10,10 +10,14 @@ Welcome to LMC Base Classes documentation! ...@@ -10,10 +10,14 @@ Welcome to LMC Base Classes documentation!
:caption: Table of Contents :caption: Table of Contents
:maxdepth: 2 :maxdepth: 2
.. automodule:: SKABaseDevice.SKABaseDeviceModule SKA Alarm Handler<SKAAlarmHandler>
SKA Base Device<SKABaseDevice>
.. autoclass:: SKABaseDevice SKA Capability<SKACapability>
:members: SKA Logger<SKALogger>
SKA Master<SKAMaster>
SKA ObsDevice<SKAObsDevice>
SKA Subarray<SKASubarray>
SKA TelState<SKATelState>
Indices and tables Indices and tables
================== ==================
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
# #
# #
"""skabasedevice.py: A generic base device for SKA. It exposes the generic attributes, """A generic base device for SKA. It exposes the generic attributes,
properties and commands of an SKA device. properties and commands of an SKA device.
""" """
from __future__ import print_function from __future__ import print_function
...@@ -642,6 +642,11 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): ...@@ -642,6 +642,11 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)):
@DebugIt() @DebugIt()
def ToJson(self, argin): def ToJson(self, argin):
# PROTECTED REGION ID(SKABaseDevice.ToJson) ENABLED START # # PROTECTED REGION ID(SKABaseDevice.ToJson) ENABLED START #
"""
ToJson method. Not used. To be deleted.
:param argin:
:return:
"""
# TBD - see how to use fandango's export_device_to_dict # TBD - see how to use fandango's export_device_to_dict
with exception_manager(self): with exception_manager(self):
......
...@@ -6,14 +6,13 @@ ...@@ -6,14 +6,13 @@
# #
"""SKABASE """SKABASE
A generic base device for SKA. It exposes the generic attributes, properties and commands of an SKA device.
__init__.py: A generic base device for SKA. It exposes the generic attributes, properties and commands of an SKA device.
""" """
# __all__ = ["SKABaseDevice", "main"] __all__ = ["SKABaseDevice", "main"]
#
# from skabase import release from skabase import release
# from .SKABaseDevice import SKABaseDevice, main from .SKABaseDevice import SKABaseDevice, main
#
# __version__ = release.version __version__ = release.version
# __version_info__ = release.version_info __version_info__ = release.version_info
# __author__ = release.author __author__ = release.author
\ No newline at end of file
# __all__ = ["auxiliary", __all__ = ["auxiliary",
# "SKAAlarmHandler", "SKAAlarmHandler",
# "SKABaseDevice", "SKABaseDevice",
# "SKACapability", "SKACapability",
# "SKALogger", "SKALogger",
# "SKAMaster", "SKAMaster",
# "SKAObsDevice", "SKAObsDevice",
# "SKASubarray", "SKASubarray",
# "SKATelState" "SKATelState"
# ] ]
# from pkgutil import extend_path
# __path__ = extend_path(__path__, __name__)
\ No newline at end of file
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
"""Release information for lmc-base-classes Python Package""" """Release information for lmc-base-classes Python Package"""
name = """lmc-base-classes""" name = """lmcbaseclasses"""
version = "1.0.0" version = "1.0.0"
version_info = version.split(".") version_info = version.split(".")
description = """A set of generic base devices for SKA Telescope.""" description = """A set of generic base devices for SKA Telescope."""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment