From 940b45ac6798c2e2f0a7bbd43f69f9fb5513ca83 Mon Sep 17 00:00:00 2001
From: Aditya Dange <adityadange.ska@gmail.com>
Date: Wed, 30 Jan 2019 12:17:14 +0530
Subject: [PATCH] Update for documentation generation
---
.gitignore | 2 +-
docs/source/SKAAlarmHandler.rst | 3 +--
docs/source/conf.py | 9 +++++++--
docs/source/index.rst | 7 -------
skabase/SKAAlarmHandler/SKAAlarmHandler.py | 8 ++++++--
skabase/SKABaseDevice/SKABaseDevice.py | 5 ++++-
skabase/SKAMaster/SKAMaster.py | 4 ----
skabase/SKAObsDevice/SKAObsDevice.py | 1 -
8 files changed, 19 insertions(+), 20 deletions(-)
diff --git a/.gitignore b/.gitignore
index f6d3277d..07cb04cc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,7 +31,7 @@ htmlcov
# Developer tools
*~
.ropeproject
-
+.idea
# Ansible
*.retry
diff --git a/docs/source/SKAAlarmHandler.rst b/docs/source/SKAAlarmHandler.rst
index 67800718..8faeae77 100644
--- a/docs/source/SKAAlarmHandler.rst
+++ b/docs/source/SKAAlarmHandler.rst
@@ -10,5 +10,4 @@ SKA AlarmHandler
:maxdepth: 2
.. automodule:: SKAAlarmHandler.SKAAlarmHandler
- :members: SKAAlarmHandler
-
+ :members: SKAAlarmHandler
\ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 3520889c..991b1cbc 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -14,7 +14,12 @@
import sys
import os
-from mock import Mock
+from mock import Mock as MagicMock
+
+class Mock(MagicMock):
+ @classmethod
+ def __getattr__(cls, name):
+ return MagicMock()
# Mock tango modules
MOCK_MODULES = ['PyTango', 'tango', 'tango.server', 'run', 'DeviceMeta', 'command',
@@ -25,7 +30,7 @@ sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
# 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.
sys.path.insert(0, os.path.abspath('../../skabase'))
-
+print ("from conf sys.path: ", sys.path)
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index cfc4a810..defdd2ec 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -12,13 +12,6 @@ Contents:
:maxdepth: 2
SKA AlarmHandler<SKAAlarmHandler>
- SKA BaseDevice<SKABaseDevice>
- SKA Capability<SKACapability>
- SKA Logger<SKALogger>
- SKA Master<SKAMaster>
- SKA ObsDevice<SKAObsDevice>
- SKA Subarray<SKASubarray>
- SKA TelState<SKATelState>
Indices and tables
==================
diff --git a/skabase/SKAAlarmHandler/SKAAlarmHandler.py b/skabase/SKAAlarmHandler/SKAAlarmHandler.py
index 78d1b464..ad489f51 100644
--- a/skabase/SKAAlarmHandler/SKAAlarmHandler.py
+++ b/skabase/SKAAlarmHandler/SKAAlarmHandler.py
@@ -23,12 +23,15 @@ import os
import sys
from future.utils import with_metaclass
-# SKA specific imports
+# SKA specific imports\
+file_path = os.path.dirname(os.path.abspath(__file__))
+# TODO: remove the release.py file
+sys.path.insert(0, os.path.abspath(os.path.join(file_path, os.curdir)))
import release # DO NOT import after modifying system path
-file_path = os.path.dirname(os.path.abspath(__file__))
basedevice_path = os.path.abspath(os.path.join(file_path, os.pardir)) + "/SKABaseDevice"
sys.path.insert(0, basedevice_path)
+print ("SKAAlarmHandler sys.path: ", sys.path)
from SKABaseDevice import SKABaseDevice
# PROTECTED REGION END # // SKAAlarmHandler.additionnal_import
@@ -101,6 +104,7 @@ class SKAAlarmHandler(with_metaclass(DeviceMeta, SKABaseDevice)):
def init_device(self):
SKABaseDevice.init_device(self)
+ # TODO: maintain single version file.
self._build_state = '{}, {}, {}'.format(release.name, release.version,
release.description)
self._version_id = release.version
diff --git a/skabase/SKABaseDevice/SKABaseDevice.py b/skabase/SKABaseDevice/SKABaseDevice.py
index fab127fe..8aa6e2d2 100644
--- a/skabase/SKABaseDevice/SKABaseDevice.py
+++ b/skabase/SKABaseDevice/SKABaseDevice.py
@@ -33,9 +33,12 @@ from builtins import range
# SKA specific imports
file_path = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, os.path.abspath(os.path.join(file_path, os.curdir)))
+import release # DO NOT import after modifying system path
+
auxiliary_path = os.path.abspath(os.path.join(file_path, os.pardir)) + "/auxiliary"
sys.path.insert(0, auxiliary_path)
-import release # DO NOT import after modifying system path
+
from utils import (get_dp_command, exception_manager,
tango_type_conversion, coerce_value,
get_groups_from_json, get_tango_device_type_id)
diff --git a/skabase/SKAMaster/SKAMaster.py b/skabase/SKAMaster/SKAMaster.py
index 6e8384ee..f7158ef0 100644
--- a/skabase/SKAMaster/SKAMaster.py
+++ b/skabase/SKAMaster/SKAMaster.py
@@ -20,10 +20,6 @@ file_path = os.path.dirname(os.path.abspath(__file__))
basedevice_path = os.path.abspath(os.path.join(file_path, os.pardir)) + "/SKABaseDevice"
sys.path.insert(0, basedevice_path)
-# basedevice_path = os.path.abspath("..") + "/SKABaseDevice"
-# sys.path.insert(0, basedevice_path)
-print(("From SKAMaster sys.path: ", sys.path))
-
# tango imports
from tango import DebugIt
from tango.server import run, DeviceMeta, attribute, command, device_property
diff --git a/skabase/SKAObsDevice/SKAObsDevice.py b/skabase/SKAObsDevice/SKAObsDevice.py
index 14aa7922..58818d35 100644
--- a/skabase/SKAObsDevice/SKAObsDevice.py
+++ b/skabase/SKAObsDevice/SKAObsDevice.py
@@ -19,7 +19,6 @@ from future.utils import with_metaclass
file_path = os.path.dirname(os.path.abspath(__file__))
basedevice_path = os.path.abspath(os.path.join(file_path, os.pardir)) + "/SKABaseDevice"
sys.path.insert(0, basedevice_path)
-print(("From SKAObsDevice sys.path: ", sys.path))
# tango imports
from tango.server import run, DeviceMeta, attribute
--
GitLab