From 07ebc1f4ed24d452f4675a4165a6ab6224b81a20 Mon Sep 17 00:00:00 2001 From: Drew Devereux <drew.devereux@csiro.au> Date: Tue, 25 May 2021 06:20:41 +0000 Subject: [PATCH] [MCCS-399] doc linting / consistency --- docs/source/api/alarm_handler_device.rst | 1 - docs/source/api/base/admin_mode_model.rst | 1 - docs/source/api/base/base_device.rst | 1 - docs/source/api/base/component_manager.rst | 1 - docs/source/api/base/index.rst | 1 + docs/source/api/base/op_state_model.rst | 1 - docs/source/api/base/reference_component_manager.rst | 1 - docs/source/api/capability_device.rst | 1 - docs/source/api/commands.rst | 1 - docs/source/api/control_model.rst | 1 - docs/source/api/csp/obs/component_manager.rst | 1 - docs/source/api/csp/obs/obs_device.rst | 1 - docs/source/api/csp/obs/obs_state_model.rst | 1 - docs/source/api/csp/obs/reference_component_manager.rst | 1 - docs/source/api/csp/subarray/component_manager.rst | 1 - docs/source/api/csp/subarray/reference_component_manager.rst | 1 - docs/source/api/csp/subarray/subarray_device.rst | 1 - docs/source/api/faults.rst | 1 - docs/source/api/logger_device.rst | 1 - docs/source/api/master_device.rst | 1 - docs/source/api/obs/index.rst | 1 + docs/source/api/obs/obs_device.rst | 1 - docs/source/api/obs/obs_state_model.rst | 1 - docs/source/api/release.rst | 1 - docs/source/api/subarray/component_manager.rst | 1 - docs/source/api/subarray/index.rst | 1 + docs/source/api/subarray/reference_component_manager.rst | 1 - docs/source/api/subarray/subarray_device.rst | 1 - docs/source/api/subarray/subarray_obs_state_model.rst | 1 - docs/source/api/tel_state_device.rst | 1 - docs/source/api/utils.rst | 1 - docs/source/guide/component_managers.rst | 1 + docs/source/guide/getting_started.rst | 1 + docs/source/guide/index.rst | 1 + 34 files changed, 6 insertions(+), 28 deletions(-) diff --git a/docs/source/api/alarm_handler_device.rst b/docs/source/api/alarm_handler_device.rst index 596275b7..be3a7d8f 100644 --- a/docs/source/api/alarm_handler_device.rst +++ b/docs/source/api/alarm_handler_device.rst @@ -1,4 +1,3 @@ - ==================== Alarm Handler Device ==================== diff --git a/docs/source/api/base/admin_mode_model.rst b/docs/source/api/base/admin_mode_model.rst index b2c37097..9d1dd0eb 100644 --- a/docs/source/api/base/admin_mode_model.rst +++ b/docs/source/api/base/admin_mode_model.rst @@ -1,4 +1,3 @@ - ================ Admin Mode Model ================ diff --git a/docs/source/api/base/base_device.rst b/docs/source/api/base/base_device.rst index 83ce6e56..8eb87944 100644 --- a/docs/source/api/base/base_device.rst +++ b/docs/source/api/base/base_device.rst @@ -1,4 +1,3 @@ - =========== Base Device =========== diff --git a/docs/source/api/base/component_manager.rst b/docs/source/api/base/component_manager.rst index b7c0ef63..3071d88a 100644 --- a/docs/source/api/base/component_manager.rst +++ b/docs/source/api/base/component_manager.rst @@ -1,4 +1,3 @@ - ====================== Base Component Manager ====================== diff --git a/docs/source/api/base/index.rst b/docs/source/api/base/index.rst index 17146d97..ecfccb70 100644 --- a/docs/source/api/base/index.rst +++ b/docs/source/api/base/index.rst @@ -1,3 +1,4 @@ +=============== Base subpackage =============== diff --git a/docs/source/api/base/op_state_model.rst b/docs/source/api/base/op_state_model.rst index c609c633..3fb7d60a 100644 --- a/docs/source/api/base/op_state_model.rst +++ b/docs/source/api/base/op_state_model.rst @@ -1,4 +1,3 @@ - ============== Op State Model ============== diff --git a/docs/source/api/base/reference_component_manager.rst b/docs/source/api/base/reference_component_manager.rst index 0f2462ad..d70135f3 100644 --- a/docs/source/api/base/reference_component_manager.rst +++ b/docs/source/api/base/reference_component_manager.rst @@ -1,4 +1,3 @@ - ================================ Reference Base Component Manager ================================ diff --git a/docs/source/api/capability_device.rst b/docs/source/api/capability_device.rst index 973e38de..52b8fb79 100644 --- a/docs/source/api/capability_device.rst +++ b/docs/source/api/capability_device.rst @@ -1,4 +1,3 @@ - ================= Capability Device ================= diff --git a/docs/source/api/commands.rst b/docs/source/api/commands.rst index 70b65579..7a251c81 100644 --- a/docs/source/api/commands.rst +++ b/docs/source/api/commands.rst @@ -1,4 +1,3 @@ - ======== Commands ======== diff --git a/docs/source/api/control_model.rst b/docs/source/api/control_model.rst index da751799..836668d3 100644 --- a/docs/source/api/control_model.rst +++ b/docs/source/api/control_model.rst @@ -1,4 +1,3 @@ - ============= Control Model ============= diff --git a/docs/source/api/csp/obs/component_manager.rst b/docs/source/api/csp/obs/component_manager.rst index 238d6c9b..d082d253 100644 --- a/docs/source/api/csp/obs/component_manager.rst +++ b/docs/source/api/csp/obs/component_manager.rst @@ -1,4 +1,3 @@ - ========================= CSP obs component manager ========================= diff --git a/docs/source/api/csp/obs/obs_device.rst b/docs/source/api/csp/obs/obs_device.rst index 7e09d1b1..d556e02d 100644 --- a/docs/source/api/csp/obs/obs_device.rst +++ b/docs/source/api/csp/obs/obs_device.rst @@ -1,4 +1,3 @@ - ========================= CSP Subelement Obs device ========================= diff --git a/docs/source/api/csp/obs/obs_state_model.rst b/docs/source/api/csp/obs/obs_state_model.rst index edafe2b8..8391d063 100644 --- a/docs/source/api/csp/obs/obs_state_model.rst +++ b/docs/source/api/csp/obs/obs_state_model.rst @@ -1,4 +1,3 @@ - ============================== CSP Subelement Obs State Model ============================== diff --git a/docs/source/api/csp/obs/reference_component_manager.rst b/docs/source/api/csp/obs/reference_component_manager.rst index 0e258e93..beb98715 100644 --- a/docs/source/api/csp/obs/reference_component_manager.rst +++ b/docs/source/api/csp/obs/reference_component_manager.rst @@ -1,4 +1,3 @@ - =================================== Reference CSP Obs Component Manager =================================== diff --git a/docs/source/api/csp/subarray/component_manager.rst b/docs/source/api/csp/subarray/component_manager.rst index cb55162b..f9e05525 100644 --- a/docs/source/api/csp/subarray/component_manager.rst +++ b/docs/source/api/csp/subarray/component_manager.rst @@ -1,4 +1,3 @@ - ============================== CSP Subarray Component Manager ============================== diff --git a/docs/source/api/csp/subarray/reference_component_manager.rst b/docs/source/api/csp/subarray/reference_component_manager.rst index 0e976a6d..4aecd76b 100644 --- a/docs/source/api/csp/subarray/reference_component_manager.rst +++ b/docs/source/api/csp/subarray/reference_component_manager.rst @@ -1,4 +1,3 @@ - ======================================== Reference CSP Subarray Component Manager ======================================== diff --git a/docs/source/api/csp/subarray/subarray_device.rst b/docs/source/api/csp/subarray/subarray_device.rst index fa3239bf..c0e7eefa 100644 --- a/docs/source/api/csp/subarray/subarray_device.rst +++ b/docs/source/api/csp/subarray/subarray_device.rst @@ -1,4 +1,3 @@ - =================== CSP Subarray device =================== diff --git a/docs/source/api/faults.rst b/docs/source/api/faults.rst index 99304531..c7701a00 100644 --- a/docs/source/api/faults.rst +++ b/docs/source/api/faults.rst @@ -1,4 +1,3 @@ - ====== Faults ====== diff --git a/docs/source/api/logger_device.rst b/docs/source/api/logger_device.rst index 7cbce328..f91ffe08 100644 --- a/docs/source/api/logger_device.rst +++ b/docs/source/api/logger_device.rst @@ -1,4 +1,3 @@ - ============= Logger Device ============= diff --git a/docs/source/api/master_device.rst b/docs/source/api/master_device.rst index b14c45df..ec74fa4c 100644 --- a/docs/source/api/master_device.rst +++ b/docs/source/api/master_device.rst @@ -1,4 +1,3 @@ - ============= Master Device ============= diff --git a/docs/source/api/obs/index.rst b/docs/source/api/obs/index.rst index 04e88fdc..5bfd51a3 100644 --- a/docs/source/api/obs/index.rst +++ b/docs/source/api/obs/index.rst @@ -1,3 +1,4 @@ +============== Obs subpackage ============== diff --git a/docs/source/api/obs/obs_device.rst b/docs/source/api/obs/obs_device.rst index bab50b23..03133428 100644 --- a/docs/source/api/obs/obs_device.rst +++ b/docs/source/api/obs/obs_device.rst @@ -1,4 +1,3 @@ - ========== Obs Device ========== diff --git a/docs/source/api/obs/obs_state_model.rst b/docs/source/api/obs/obs_state_model.rst index 1f072c7a..03424339 100644 --- a/docs/source/api/obs/obs_state_model.rst +++ b/docs/source/api/obs/obs_state_model.rst @@ -1,4 +1,3 @@ - =============== Obs State Model =============== diff --git a/docs/source/api/release.rst b/docs/source/api/release.rst index 8854d763..a7576ace 100644 --- a/docs/source/api/release.rst +++ b/docs/source/api/release.rst @@ -1,4 +1,3 @@ - ======= Release ======= diff --git a/docs/source/api/subarray/component_manager.rst b/docs/source/api/subarray/component_manager.rst index d8d4a2c0..d1d83e3c 100644 --- a/docs/source/api/subarray/component_manager.rst +++ b/docs/source/api/subarray/component_manager.rst @@ -1,4 +1,3 @@ - ========================== Subarray Component Manager ========================== diff --git a/docs/source/api/subarray/index.rst b/docs/source/api/subarray/index.rst index 471a4d3a..58a07a06 100644 --- a/docs/source/api/subarray/index.rst +++ b/docs/source/api/subarray/index.rst @@ -1,3 +1,4 @@ +======== Subarray ======== diff --git a/docs/source/api/subarray/reference_component_manager.rst b/docs/source/api/subarray/reference_component_manager.rst index 812466e8..b39b1688 100644 --- a/docs/source/api/subarray/reference_component_manager.rst +++ b/docs/source/api/subarray/reference_component_manager.rst @@ -1,4 +1,3 @@ - ==================================== Reference Subarray Component Manager ==================================== diff --git a/docs/source/api/subarray/subarray_device.rst b/docs/source/api/subarray/subarray_device.rst index 7333fd52..881e7dd6 100644 --- a/docs/source/api/subarray/subarray_device.rst +++ b/docs/source/api/subarray/subarray_device.rst @@ -1,4 +1,3 @@ - =============== Subarray Device =============== diff --git a/docs/source/api/subarray/subarray_obs_state_model.rst b/docs/source/api/subarray/subarray_obs_state_model.rst index 74123e43..ec0fec9e 100644 --- a/docs/source/api/subarray/subarray_obs_state_model.rst +++ b/docs/source/api/subarray/subarray_obs_state_model.rst @@ -1,4 +1,3 @@ - ======================== Subarray Obs State Model ======================== diff --git a/docs/source/api/tel_state_device.rst b/docs/source/api/tel_state_device.rst index dbbc3ea9..b32cb68e 100644 --- a/docs/source/api/tel_state_device.rst +++ b/docs/source/api/tel_state_device.rst @@ -1,4 +1,3 @@ - ================ Tel State Device ================ diff --git a/docs/source/api/utils.rst b/docs/source/api/utils.rst index bd064582..c145bd88 100644 --- a/docs/source/api/utils.rst +++ b/docs/source/api/utils.rst @@ -1,4 +1,3 @@ - ===== Utils ===== diff --git a/docs/source/guide/component_managers.rst b/docs/source/guide/component_managers.rst index 4e0ca54d..cd182d01 100644 --- a/docs/source/guide/component_managers.rst +++ b/docs/source/guide/component_managers.rst @@ -1,3 +1,4 @@ +================================= Components and component managers ================================= diff --git a/docs/source/guide/getting_started.rst b/docs/source/guide/getting_started.rst index 7769c645..0b67fedf 100644 --- a/docs/source/guide/getting_started.rst +++ b/docs/source/guide/getting_started.rst @@ -1,3 +1,4 @@ +=============== Getting started =============== This page will guide you through the steps to writing a SKA Tango device diff --git a/docs/source/guide/index.rst b/docs/source/guide/index.rst index 40fdcc2c..2d0b701b 100644 --- a/docs/source/guide/index.rst +++ b/docs/source/guide/index.rst @@ -1,3 +1,4 @@ +=============== Developer Guide =============== -- GitLab