Code Documentation

.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+name: Documentation
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+
+      - name: Install siriuspy dependencies
+        run: pip install -r siriuspy/requirements.txt
+
+      - name: Install siriuspy
+        run: pip install siriuspy/
+
+      - name: Install docs dependencies
+        run: pip install -r siriuspy/docs/doc_requirements.txt
+
+      - name: Build HTML
+        run: sphinx-build -b html siriuspy/docs/source/ ./public
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+          force_orphan: true

siriuspy/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

siriuspy/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

siriuspy/docs/source/conf.py

@@ -0,0 +1,58 @@
+import sys
+import os
+import datetime
+from importlib import metadata
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+package_data = metadata.metadata("siriuspy")
+year = datetime.date.today().year
+project = package_data["Name"]
+author = package_data["Author"]
+copyright = f'{year}, {author}'
+release = metadata.version("siriuspy")
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+	'sphinx.ext.autodoc',
+	'sphinx.ext.viewcode',
+	'sphinx.ext.napoleon'
+]
+
+autodoc_default_options = {
+	"members": True,
+	"undoc-members": True,
+	"private-members": True
+}
+
+source_suffix = ['.rst', '.md']
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+html_context = {
+    "display_github": True,
+    "github_user": "lnls-sirius",
+    "github_repo": "hla",
+    "github_version": "master",
+    "conf_py_path": "/siriuspy/docs/source/"
+}
+

siriuspy/docs/source/index.rst

@@ -0,0 +1,61 @@
+.. siriuspy documentation master file, created by
+   sphinx-quickstart on Thu Jun 13 14:32:37 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to siriuspy's documentation!
+====================================
+
+Siriuspy is a package with the Sirius control system classes and utility functions used in HLA and IOC applications.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Content:
+
+   siriuspy.bsmp
+   siriuspy.clientarch
+   siriuspy.clientconfigdb
+   siriuspy.clientweb
+   siriuspy.currinfo
+   siriuspy.cycle
+   siriuspy.devices
+   siriuspy.diagbeam
+   siriuspy.diagsys
+   siriuspy.dvfimgproc
+   siriuspy.epics
+   siriuspy.fofb
+   siriuspy.idff
+   siriuspy.injctrl
+   siriuspy.machshift
+   siriuspy.magnet
+   siriuspy.meas
+   siriuspy.namesys
+   siriuspy.optics
+   siriuspy.opticscorr
+   siriuspy.orbintlk
+   siriuspy.oscilloscope
+   siriuspy.posang
+   siriuspy.pwrsupply
+   siriuspy.ramp
+   siriuspy.search
+   siriuspy.simul
+   siriuspy.sofb
+   siriuspy.stabinfo
+   siriuspy.timesys
+
+.. toctree::
+   :caption: Source Code:
+
+   dev-packages/siriuspy Github <https://github.com/lnls-sirius/dev-packages>
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

siriuspy/docs/source/siriuspy.bsmp.rst

@@ -0,0 +1,60 @@
+siriuspy.bsmp
+=============
+
+siriuspy.bsmp.commands
+----------------------
+
+.. automodule:: siriuspy.bsmp.commands
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.bsmp.constants
+-----------------------
+
+.. automodule:: siriuspy.bsmp.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.bsmp.entities
+----------------------
+
+.. automodule:: siriuspy.bsmp.entities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.bsmp.exceptions
+------------------------
+
+.. automodule:: siriuspy.bsmp.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.bsmp.serial
+--------------------
+
+.. automodule:: siriuspy.bsmp.serial
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+siriuspy.bsmp.types
+-------------------
+
+.. automodule:: siriuspy.bsmp.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: siriuspy.bsmp
+   :members:
+   :undoc-members:
+   :show-inheritance:

siriuspy/docs/source/siriuspy.clientarch.rst

@@ -0,0 +1,52 @@
+siriuspy.clientarch
+===================
+
+
+siriuspy.clientarch.client
+--------------------------
+
+.. automodule:: siriuspy.clientarch.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.clientarch.devices
+---------------------------
+
+.. automodule:: siriuspy.clientarch.devices
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.clientarch.exceptions
+------------------------------
+
+.. automodule:: siriuspy.clientarch.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.clientarch.pvarch
+--------------------------
+
+.. automodule:: siriuspy.clientarch.pvarch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.clientarch.time
+------------------------
+
+.. automodule:: siriuspy.clientarch.time
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: siriuspy.clientarch
+   :members:
+   :undoc-members:
+   :show-inheritance:

siriuspy/docs/source/siriuspy.clientconfigdb.rst

@@ -0,0 +1,50 @@
+siriuspy.clientconfigdb
+=======================
+
+Subpackage
+----------
+
+.. toctree::
+   :maxdepth: 2
+
+   siriuspy.clientconfigdb.types
+
+siriuspy.clientconfigdb.configdb_client
+---------------------------------------
+
+.. automodule:: siriuspy.clientconfigdb.configdb_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.clientconfigdb.configdb_document
+-----------------------------------------
+
+.. automodule:: siriuspy.clientconfigdb.configdb_document
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.clientconfigdb.pvsconfig
+---------------------------------
+
+.. automodule:: siriuspy.clientconfigdb.pvsconfig
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriuspy.clientconfigdb._templates
+----------------------------------
+
+.. automodule:: siriuspy.clientconfigdb._templates
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: siriuspy.clientconfigdb
+   :members:
+   :undoc-members:
+   :show-inheritance: