v0.16.1

version 0.16.1

Author: thusser

docs/Makefile

@@ -0,0 +1,31 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = pyobs
+SOURCEDIR     = source
+BUILDDIR      = ../.doc-build
+
+#.EXPORT_ALL_VARIABLES:
+
+#PYTHONPATH:=../pyobs-core/:../pyobs-sbig/:../pyobs-fli:../pyobs-weather:../pyobs-archive:${PYTHONPATH}
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+html:
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+livehtml:
+	sphinx-autobuild -b html --watch ../pyobs_sbig $(ALLSPHINXOPTS) "$(SOURCEDIR)/" "$(BUILDDIR)/html/"
+
+# 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)
+

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=pyobs
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/_static/pyobs.gif

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# 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.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../"))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "pyobs-alpaca"
+copyright = "2022, Tim-Oliver Husser"
+author = "Tim-Oliver Husser"
+
+# The short X.Y version
+# version = "0.16"
+# The full version, including alpha/beta/rc tags
+# release = "0.16.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+add_module_names = False
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.intersphinx",
+    #'sphinx_autodoc_typehints'
+]
+
+intersphinx_mapping = {"http://docs.python.org/3": None}
+
+# napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_use_param = False
+napoleon_use_ivar = True
+
+# typehints
+# set_type_checking_flag = True
+# autodoc_typehints = "description"
+
+# show c'tor parameters in class only
+autoclass_content = "both"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# Be a little nitpicky
+nitpicky = True
+nitpick_ignore = []
+
+# intersphinx
+intersphinx_mapping = {
+    "pyobs": ("https://pyobs-core.readthedocs.io/en/latest/", None),
+}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "collapse_navigation": False,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "display_version": False,
+    "logo_only": False,
+    "prev_next_buttons_location": "bottom",
+    "titles_only": False,
+    "style_nav_header_background": "#cccccc",
+}
+html_logo = "_static/pyobs.gif"

docs/source/conf.py

@@ -0,0 +1,35 @@
+pyobs-alpaca
+############
+
+This is a `pyobs <https://www.pyobs.org>`_ (`documentation <https://docs.pyobs.org>`_) module for ALPACA, which is
+a HTTP proxy for ASCOM.
+
+
+Example configuration
+*********************
+
+
+Available classes
+*****************
+
+These classes are meant more as a means of an example for own implementations. :ref:`AlpacaTelescope` is an
+implementation for telescopes, while :ref:`AlpacaFocuser` works for focusing devices and :ref:`AlpacaDome` can
+operate a dome.
+
+AlpacaTelescope
+===============
+.. autoclass:: pyobs_alpaca.AlpacaTelescope
+   :members:
+   :show-inheritance:
+
+AlpacaFocuser
+=============
+.. autoclass:: pyobs_alpaca.AlpacaFocuser
+   :members:
+   :show-inheritance:
+
+AlpacaDome
+==========
+.. autoclass:: pyobs_alpaca.AlpacaDome
+   :members:
+   :show-inheritance:

docs/source/index.rst

@@ -68,7 +68,7 @@ async def init(self, **kwargs: Any) -> None:
         """Open dome.
 
         Raises:
-            InitError: If dome cannot be opened.
+            pyobs.utils.exceptions.InitError: If dome cannot be opened.
         """
 
         # if already opening, ignore
@@ -115,7 +115,7 @@ async def park(self, **kwargs: Any) -> None:
         """Close dome.
 
         Raises:
-            ParkError: If dome cannot be opened.
+            pyobs.utils.exceptions.ParkError: If dome cannot be opened.
         """
 
         # if already closing, ignore
@@ -166,7 +166,7 @@ async def _move(self, az: float, abort: asyncio.Event) -> None:
             abort: Abort event.
 
         Raises:
-            MoveError: If dome cannot be moved.
+            pyobs.utils.exceptions.MoveError: If dome cannot be moved.
         """
 
         # execute command
@@ -210,7 +210,7 @@ async def move_altaz(self, alt: float, az: float, **kwargs: Any) -> None:
             az: Az in deg to move to.
 
         Raises:
-            MoveError: If device could not be moved.
+            pyobs.utils.exceptions.MoveError: If device could not be moved.
         """
 
         # do nothing, if not ready

pyobs_alpaca/dome.py

@@ -50,15 +50,15 @@ async def init(self, **kwargs: Any) -> None:
         """Initialize device.
 
         Raises:
-            InitError: If device could not be initialized.
+            pyobs.utils.exceptions.InitError: If device could not be initialized.
         """
         pass
 
     async def park(self, **kwargs: Any) -> None:
         """Park device.
 
         Raises:
-            ParkError: If device could not be parked.
+            pyobs.utils.exceptions.ParkError: If device could not be parked.
         """
         pass
 
@@ -92,7 +92,7 @@ async def set_focus(self, focus: float, **kwargs: Any) -> None:
         """Sets new focus.
 
         Raises:
-            MoveError: If telescope cannot be moved.
+            pyobs.utils.exceptions.MoveError: If telescope cannot be moved.
         """
 
         # set focus + offset

pyobs_alpaca/focuser.py

@@ -87,7 +87,7 @@ async def init(self, **kwargs: Any) -> None:
         """Initialize telescope.
 
         Raises:
-            InitError: If telescope could not be initialized.
+            pyobs.utils.exceptions.InitError: If telescope could not be initialized.
         """
 
         # if already initializing, ignore
@@ -119,7 +119,7 @@ async def park(self, **kwargs: Any) -> None:
         """Park telescope.
 
         Raises:
-            ParkError: If telescope could not be parked.
+            pyobs.utils.exceptions.ParkError: If telescope could not be parked.
         """
 
         # if already parking, ignore
@@ -156,7 +156,7 @@ async def _move_altaz(self, alt: float, az: float, abort_event: asyncio.Event) -
             abort_event: Event that gets triggered when movement should be aborted.
 
         Raises:
-            Exception: On error.
+            pyobs.utils.exceptions.MoveError: If telescope cannot be moved.
         """
 
         # reset offsets
@@ -191,7 +191,7 @@ async def _move_radec(self, ra: float, dec: float, abort_event: asyncio.Event) -
             abort_event: Event that gets triggered when movement should be aborted.
 
         Raises:
-            Exception: On any error.
+            pyobs.utils.exceptions.MoveError: If telescope cannot be moved.
         """
 
         # reset offsets
@@ -225,7 +225,7 @@ async def set_offsets_radec(self, dra: float, ddec: float, **kwargs: Any) -> Non
             ddec: Dec offset in degrees.
 
         Raises:
-            MoveError: If offset could not be set.
+            pyobs.utils.exceptions.MoveError: If offset could not be set.
         """
 
         # acquire lock

pyobs_alpaca/telescope.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyobs-alpaca"
-version = "0.16.0"
+version = "0.16.1"
 description = "pyobs module for ASCOM Alpaca"
 authors = ["Tim-Oliver Husser <thusser@uni-goettingen.de>"]
 license = "MIT"