From 3d889cf4a8135e1654fc71a597ffd29d47ffc644 Mon Sep 17 00:00:00 2001 From: Aditya Dange <adityadange.ska@gmail.com> Date: Wed, 6 Feb 2019 18:47:10 +0530 Subject: [PATCH] Change rst files for document generation. Unified format of all rst files. --- docs/source/SKAAlarmHandler.rst | 5 +++-- docs/source/SKACapability.rst | 6 +++--- docs/source/SKALogger.rst | 6 +++--- docs/source/SKAMaster.rst | 5 +++-- docs/source/SKAObsDevice.rst | 6 +++--- docs/source/SKASubarray.rst | 6 +++--- docs/source/SKATelState.rst | 6 +++--- skabase/SKABaseDevice/__init__.py | 3 +-- 8 files changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/source/SKAAlarmHandler.rst b/docs/source/SKAAlarmHandler.rst index 11bd513e..bb7b1984 100644 --- a/docs/source/SKAAlarmHandler.rst +++ b/docs/source/SKAAlarmHandler.rst @@ -9,5 +9,6 @@ SKA AlarmHandler .. toctree:: :maxdepth: 2 -.. automodule:: SKAAlarmHandler.SKAAlarmHandler - :members: SKAAlarmHandler +.. automodule:: SKAAlarmHandler +.. autoclass:: SKAAlarmHandler + :members: diff --git a/docs/source/SKACapability.rst b/docs/source/SKACapability.rst index 664fbb72..5b08ec17 100644 --- a/docs/source/SKACapability.rst +++ b/docs/source/SKACapability.rst @@ -9,6 +9,6 @@ SKA Capability .. toctree:: :maxdepth: 2 -.. automodule:: SKACapability.SKACapability - :members: SKACapability - +.. automodule:: SKACapability +.. autoclass:: SKACapability + :members: diff --git a/docs/source/SKALogger.rst b/docs/source/SKALogger.rst index 0a403da0..b2ce592f 100644 --- a/docs/source/SKALogger.rst +++ b/docs/source/SKALogger.rst @@ -9,6 +9,6 @@ SKA Logger .. toctree:: :maxdepth: 2 -.. automodule:: SKALogger.SKALogger - :members: SKALogger - +.. automodule:: SKALogger +.. autoclass:: SKALogger + :members: diff --git a/docs/source/SKAMaster.rst b/docs/source/SKAMaster.rst index 23c1951f..7939c225 100644 --- a/docs/source/SKAMaster.rst +++ b/docs/source/SKAMaster.rst @@ -9,6 +9,7 @@ SKA Master .. toctree:: :maxdepth: 2 -.. automodule:: SKAMaster.SKAMaster - :members: SKAMaster +.. automodule:: SKAMaster +.. autoclass:: SKAMaster + :members: diff --git a/docs/source/SKAObsDevice.rst b/docs/source/SKAObsDevice.rst index effee65f..6a132beb 100644 --- a/docs/source/SKAObsDevice.rst +++ b/docs/source/SKAObsDevice.rst @@ -9,6 +9,6 @@ SKA ObsDevice .. toctree:: :maxdepth: 2 -.. automodule:: SKAObsDevice.SKAObsDevice - :members: SKAObsDevice - +.. automodule:: SKAObsDevice +.. autoclass:: SKAObsDevice + :members: diff --git a/docs/source/SKASubarray.rst b/docs/source/SKASubarray.rst index ada9fef9..6743aab4 100644 --- a/docs/source/SKASubarray.rst +++ b/docs/source/SKASubarray.rst @@ -9,6 +9,6 @@ SKA Subarray .. toctree:: :maxdepth: 2 -.. automodule:: SKASubarray.SKASubarray - :members: SKASubarray - +.. automodule:: SKASubarray +.. autoclass:: SKASubarray + :members: diff --git a/docs/source/SKATelState.rst b/docs/source/SKATelState.rst index 7843a841..0810c85c 100644 --- a/docs/source/SKATelState.rst +++ b/docs/source/SKATelState.rst @@ -9,6 +9,6 @@ SKA TelState .. toctree:: :maxdepth: 2 -.. automodule:: SKATelState.SKATelState - :members: SKATelState - +.. automodule:: SKATelState +.. autoclass:: SKATelState + :members: diff --git a/skabase/SKABaseDevice/__init__.py b/skabase/SKABaseDevice/__init__.py index 20529689..c08726ce 100644 --- a/skabase/SKABaseDevice/__init__.py +++ b/skabase/SKABaseDevice/__init__.py @@ -5,8 +5,7 @@ # # - -"""SKABase +"""SKABaseDevice A generic base device for SKA. It exposes the attributes, properties and commands of a device that are common for all the SKA devices. -- GitLab