Merge branch 'dev'

.github/workflows/deploy-docs.yml

@@ -0,0 +1,40 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main 
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9' 
+
+    - name: Install dependencies
+      env:
+        PIPENV_VENV_IN_PROJECT: true
+      run: |
+        python -m pip install --upgrade pip
+        pip install pipenv
+        pipenv install -d
+        sudo apt-get update && sudo apt-get install -y pandoc
+
+    - name: Build documentation
+      run: |
+        pandoc -s readme.md -o docs/readme.rst
+        pipenv run sphinx-build -M html docs/ docs/_build
+
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html

.gitignore

@@ -5,10 +5,12 @@ dev/
 *.err
 .vscode/
 __pycache__/
-*.txt
 build/
 *.egg-info
 *.bin
 *.fzz
 dist/
-*.sh
+*.sh
+.clang-format
+docs/_build/*
+docs/readme.rst

Pipfile

@@ -16,13 +16,18 @@ nest-asyncio = "*"
 aiofiles = "*"
 pybela = {editable = true, path = "."}
 paramiko = "*"
+numpy = "==1.26"
 
 [dev-packages]
-build = "*"
 twine = "*"
+pip-chill = "*"
+sphinx = "*"
+sphinx-rtd-theme = "*"
+build = "*"
 
 [scripts]
 test = "python test/test.py"
+test-send = "python test/test-send.py"
 
 [requires]
-python_version = "3.10"
+python_version = "3.9"

docs/_static/custom.css

@@ -0,0 +1,3 @@
+footer {
+    display: none !important;
+}

docs/conf.py

@@ -0,0 +1,63 @@
+# 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
+
+import os
+import sys
+import re
+sys.path.insert(0, os.path.abspath('../pybela'))
+
+author = 'Teresa Pelinski'
+copyright = '2024'
+def get_version_from_setup_py():
+    version_pattern = re.compile(r"version=['\"]([^'\"]+)['\"]")
+    with open('../setup.py', 'r') as f:
+        setup_py_content = f.read()
+    match = version_pattern.search(setup_py_content)
+    if match:
+        return match.group(1)
+    raise RuntimeError("Unable to find version string in setup.py")
+
+release = get_version_from_setup_py()
+project = f'pybela {release}'
+
+# -- General configuration ---------------------------------------------------
+extensions = [
+    'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinx_rtd_theme']
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '../pybela/utils.py']
+
+
+# -- Options for HTML output -------------------------------------------------
+html_theme = 'sphinx_rtd_theme'
+html_css_files = [
+    'custom.css',
+]
+html_static_path = ['_static']
+html_css_files = ['custom.css']
+html_show_sphinx = False
+html_show_sourcelink = False
+html_sidebars = {
+    '**': ['globaltoc.html', 'searchbox.html']
+}
+html_theme_options = {
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'titles_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'None',
+}
+
+# remove title from readme file to avoid duplication
+file_path = 'readme.rst'
+
+with open(file_path, 'r+') as file:
+    lines = file.readlines()[2:]  # Read lines and skip the first two
+    file.seek(0)  # Move the cursor to the beginning of the file
+    file.writelines(lines)  # Write the modified lines
+    file.truncate()  # Truncate the file to the new size

docs/docs-readme.md

@@ -0,0 +1,9 @@
+To build the docs you will need to install `pandoc` to convert the `readme.md` into `rst` (the format used by `sphinx`, the docs builder). You can see the installation instructions [here](https://pandoc.org/installing.html).
+
+Then you can build the docs with:
+
+```bash
+rm -r _build
+pandoc -s ../readme.md -o readme.rst
+pipenv run sphinx-build -M html . _build
+```

docs/index.rst

@@ -0,0 +1,29 @@
+.. pybela documentation master file, created by
+   sphinx-quickstart on Tue Aug  6 18:36:50 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+pybela docs
+===========
+Welcome to pybela’s documentation!
+
+.. include:: readme.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Getting started with pybela
+   :hidden:
+
+   readme
+
+.. toctree::
+   :caption: Module documentation
+   :maxdepth: 4
+   :hidden:
+
+   genindex
+   modules
+
+
+
+

docs/modules.rst

@@ -0,0 +1,25 @@
+
+.. automodule:: pybela.Watcher
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: pybela.Streamer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: pybela.Logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: pybela.Monitor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: pybela.Controller
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybela/Controller.py

@@ -1,6 +1,6 @@
 import asyncio
 from .Watcher import Watcher
-from .utils import print_info, print_warning
+from .utils import _print_info, _print_warning
 
 
 class Controller(Watcher):
@@ -40,7 +40,7 @@ async def async_wait_for_control_mode_to_be_set(variables=variables):
 
         asyncio.run(async_wait_for_control_mode_to_be_set(variables=variables))
 
-        print_info(
+        _print_info(
             f"Started controlling variables {variables}... Run stop_controlling() to stop controlling the variable values.")
 
     def stop_controlling(self, variables=[]):
@@ -65,7 +65,7 @@ async def async_wait_for_control_mode_to_be_set(variables=variables):
 
         asyncio.run(async_wait_for_control_mode_to_be_set(variables=variables))
 
-        print_info(f"Stopped controlling variables {variables}.")
+        _print_info(f"Stopped controlling variables {variables}.")
 
     def send_value(self, variables, values):
         """Send a value to the given variables. 
@@ -90,7 +90,7 @@ def send_value(self, variables, values):
             value = values[variables.index(var)]
 
             if value % 1 != 0 and _type in ["i", "j"]:
-                print_warning(
+                _print_warning(
                     f"Value {value} is not an integer, but the variable {var} is of type {_type}. Only the integer part will be sent.")
 
         self.send_ctrl_msg(