Skip to content
Snippets Groups Projects
Commit 551ca77a authored by Elisabetta Giani's avatar Elisabetta Giani
Browse files

AT5-370: first attempt to generate CSP.LMC SubElement Classes documentation.

parent a9803bb8
No related branches found
No related tags found
1 merge request!5Request to merge AT5-370 branch with master
Pipeline #11354 passed
......@@ -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):
......@@ -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
......
......@@ -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
---------------------------
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment