From 551ca77a536901a3d5cfa6136b66ddf628969183 Mon Sep 17 00:00:00 2001
From: softir <elisabetta.giani@inaf.it>
Date: Tue, 7 Apr 2020 10:11:11 +0200
Subject: [PATCH] AT5-370: first attempt to generate CSP.LMC SubElement Classes
documentation.
---
docs/src/conf.py | 17 ++++++++++++-----
docs/src/package/guide.rst | 32 ++++++++++++++++++--------------
2 files changed, 30 insertions(+), 19 deletions(-)
diff --git a/docs/src/conf.py b/docs/src/conf.py
index 8ee1cc5..fae9193 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -17,9 +17,16 @@
# 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',
+ 'future', 'future.utils', 'logging', 'logging.handlers', 'ska',
+ 'ska.base', 'SKAMaster', 'SKASubarray','numpy',
+ 'csp_lmc_common'
+ ]
+autodoc_member_order = 'bysource'
+
import os
import sys
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('../../'))
import sphinx_rtd_theme
def setup(app):
@@ -45,7 +52,7 @@ 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']
@@ -60,9 +67,9 @@ source_suffix = ['.rst', '.md']
master_doc = 'index'
# General information about the project.
-project = 'developer.skatelescope.org'
-copyright = '2018, SKA Organization'
-author = 'Marco Bartolini'
+project = 'Csp:LMC Subelement Classes'
+copyright = '2020, INAF-SKA Organization'
+author = '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
diff --git a/docs/src/package/guide.rst b/docs/src/package/guide.rst
index 9b3c93e..f5bf107 100644
--- a/docs/src/package/guide.rst
+++ b/docs/src/package/guide.rst
@@ -2,18 +2,13 @@
.. _package-guide:
.. todo::
- - Insert todo's here
+ - write documentation for private and protected attributes and methods of
+ the CSP.LMC Subelement classes.
-**************************
-Package-name documentation
-**************************
+*****************************************
+CSP.LMC Subelement Classes documentation
+*****************************************
-This section describes requirements and guidelines.
-
-Subtitle
-========
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
.. Automatic API Documentation section. Generating the API from the docstrings. Modify / change the directory structure as you like
@@ -22,11 +17,20 @@ Public API Documentation
Functions
---------
-.. automodule:: ska_python_skeleton.ska_python_skeleton
+.. automodule:: cspse.lmc.subelement_master
+ :members:
+
+CspSubElementMaster Class
+-------------------------
+.. autoclass:: cspse.lmc.subelement_master.CspSubElementMaster
+ :noindex:
:members:
-Classes
--------
-.. autoclass:: ska_python_skeleton.ska_python_skeleton.SKA
+CspSubElementSubarray Class
+---------------------------
+.. autoclass:: cspse.lmc.subelement_master.CspSubElementMaster
:noindex:
:members:
+
+CspSubElementSubarray Class
+---------------------------
--
GitLab