Merge pull request #689 from lnls-sirius/documentation

Documentation Page

.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 siriushla dependencies
+        run: pip install -r pyqt-apps/requirements.txt
+
+      - name: Install siriushla
+        run: pip install pyqt-apps/
+
+      - name: Install docs dependencies
+        run: pip install -r pyqt-apps/docs/doc_requirements.txt
+
+      - name: Build HTML
+        run: sphinx-build -b html pyqt-apps/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

pyqt-apps/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)

pyqt-apps/docs/doc_requirements.txt

@@ -0,0 +1,4 @@
+sphinx==7.2.6
+sphinx_rtd_theme==2.0.0
+pyqt5==5.15.10
+matplotlib==3.6.3

pyqt-apps/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

pyqt-apps/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('../..'))
+# 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
+
+pkg_data = metadata.metadata("siriushla")
+year = datetime.date.today().year
+author = pkg_data["Author"]
+name = pkg_data["Name"]
+version = metadata.version("siriushla")
+
+project = name
+copyright = f'{year}, {author}'
+author = author
+release = version
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon'
+]
+
+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
+autodoc_mock_imports = ["siriuspy", "pcaspy"]
+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": "/pyqt-apps/docs/source/"
+}

pyqt-apps/docs/source/index.rst

@@ -0,0 +1,77 @@
+.. Sirius HLA documentation master file, created by
+   sphinx-quickstart on Tue Jan 16 13:12:44 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Sirius HLA's documentation!
+======================================
+
+.. automodule:: siriushla
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: GUIs:
+
+   siriushla.as_ap_configdb
+   siriushla.as_ap_currinfo
+   siriushla.as_ap_energybutton
+   siriushla.as_ap_injcontrol
+   siriushla.as_ap_injection
+   siriushla.as_ap_launcher
+   siriushla.as_ap_machshift
+   siriushla.as_ap_macreport
+   siriushla.as_ap_magoffconv
+   siriushla.as_ap_measure
+   siriushla.as_ap_monitor
+   siriushla.as_ap_opticscorr
+   siriushla.as_ap_posang
+   siriushla.as_ap_rabpmmon
+   siriushla.as_ap_radmon
+   siriushla.as_ap_sofb
+   siriushla.as_di_bpms
+   siriushla.as_di_dccts
+   siriushla.as_di_icts
+   siriushla.as_di_scrns
+   siriushla.as_di_tune
+   siriushla.as_di_vlight
+   siriushla.as_ps_commands
+   siriushla.as_ps_control
+   siriushla.as_ps_cycle
+   siriushla.as_ps_diag
+   siriushla.as_pu_control
+   siriushla.as_rf_control
+   siriushla.as_ti_control
+   siriushla.bl_ap_imgproc
+   siriushla.bo_ap_ramp
+   siriushla.common
+   siriushla.li_ap_mps
+   siriushla.li_di_bpms
+   siriushla.li_di_scrns
+   siriushla.li_eg_control
+   siriushla.li_pu_modltr
+   siriushla.li_rf_llrf
+   siriushla.li_va_control
+   siriushla.si_ap_fofb
+   siriushla.si_ap_genstatus
+   siriushla.si_ap_idff
+   siriushla.si_ap_orbintlk
+   siriushla.si_di_bbb
+   siriushla.si_di_equalize_bpms
+   siriushla.si_di_scraps
+   siriushla.si_id_control
+   siriushla.tb_di_slits
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Widgets:
+
+   siriushla
+   siriushla.widgets
+
+.. toctree::
+   :caption: Source Code:
+
+   HLA Github <https://github.com/lnls-sirius/hla>

pyqt-apps/docs/source/siriushla.as_ap_configdb.models.rst

@@ -0,0 +1,43 @@
+siriushla.as\_ap\_configdb.models
+=================================
+
+.. automodule:: siriushla.as_ap_configdb.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Code Documentation
+------------------
+
+
+siriushla.as\_ap\_configdb.models.config\_db\_table\_model module
+-----------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.models.config_db_table_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.models.config\_names\_model module
+-------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.models.config_names_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.models.config\_types\_model module
+-------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.models.config_types_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.models.pv\_configuration\_model module
+-----------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.models.pv_configuration_model
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyqt-apps/docs/source/siriushla.as_ap_configdb.normconfigs.rst

@@ -0,0 +1,45 @@
+siriushla.as\_ap\_configdb.normconfigs
+======================================
+
+Code Documentation
+------------------
+
+siriushla.as\_ap\_configdb.normconfigs.ConfigManagerWindow module
+-----------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.normconfigs.ConfigManagerWindow
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.normconfigs.ConfigModel module
+---------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.normconfigs.ConfigModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.normconfigs.LoadingThread module
+-----------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.normconfigs.LoadingThread
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.normconfigs.TuneDlg module
+-----------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.normconfigs.TuneDlg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: siriushla.as_ap_configdb.normconfigs
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyqt-apps/docs/source/siriushla.as_ap_configdb.pvsconfigs.delegate.rst

@@ -0,0 +1,21 @@
+siriushla.as\_ap\_configdb.pvsconfigs.delegate
+==============================================
+
+Code Documentation
+------------------
+
+siriushla.as\_ap\_configdb.pvsconfigs.delegate.pv\_configuration\_delegate module
+---------------------------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.pvsconfigs.delegate.pv_configuration_delegate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: siriushla.as_ap_configdb.pvsconfigs.delegate
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyqt-apps/docs/source/siriushla.as_ap_configdb.pvsconfigs.rst

@@ -0,0 +1,45 @@
+siriushla.as\_ap\_configdb.pvsconfigs
+=====================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   siriushla.as_ap_configdb.pvsconfigs.delegate
+
+Code Documentation
+------------------
+
+siriushla.as\_ap\_configdb.pvsconfigs.load\_and\_apply module
+-------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.pvsconfigs.load_and_apply
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.pvsconfigs.main module
+-------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.pvsconfigs.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+siriushla.as\_ap\_configdb.pvsconfigs.read\_and\_save module
+------------------------------------------------------------
+
+.. automodule:: siriushla.as_ap_configdb.pvsconfigs.read_and_save
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: siriushla.as_ap_configdb.pvsconfigs
+   :members:
+   :undoc-members:
+   :show-inheritance: