clean documentation

mworion · Apr 19, 2024 · 2303e11 · 2303e11
1 parent 0051c7c
commit 2303e11
Show file tree

Hide file tree

Showing 138 changed files with 267 additions and 10,416 deletions.
diff --git a/.github/actions/build_package/action.yml b/.github/actions/build_package/action.yml
@@ -1,6 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# v1.0, Michael Wuertenberger
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: build_package
 description: build package and uploads as artifact
 

diff --git a/.github/actions/install_ubuntu_head/action.yml b/.github/actions/install_ubuntu_head/action.yml
@@ -1,6 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# v1.0, Michael Wuertenberger
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: install_ubuntu_head
 description: installs headless setup for ubuntu
 

diff --git a/.github/actions/setup_test/action.yml b/.github/actions/setup_test/action.yml
@@ -1,6 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# v1.0, Michael Wuertenberger
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: setup test
 description: download package install and install test environment
 

diff --git a/.github/actions/setup_test_cov/action.yml b/.github/actions/setup_test_cov/action.yml
@@ -1,6 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# v1.0, Michael Wuertenberger
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: setup test coverage
 description: download package install and install test environment for coverage
 

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -1,14 +1,20 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
+############################################################
+# -*- coding: utf-8 -*-
 #
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: "CodeQL"
 
 on:

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,50 @@
+############################################################
+# -*- coding: utf-8 -*-
+#
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
+#
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme alabaster rst2pdf sphinx-copybutton
+      - name: Sphinx build
+        run: |
+          sphinx-build doc doc/build
+      - name: check files
+        run: |
+          ls -la
+          ls -la doc/build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: doc/build
+          force_orphan: true
diff --git a/.github/workflows/issues_stale.yml b/.github/workflows/issues_stale.yml
@@ -1,8 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# GitHub actions for running the unit test of the mountwizzard4 package
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# v0.1, Michael Wuertenberger
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: 'Close stale issues and PRs'
 
 on:

diff --git a/.github/workflows/test_scripts_aarch64_pypi.yml b/.github/workflows/test_scripts_aarch64_pypi.yml
@@ -1,8 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# GitHub actions for checking the installation of MW4 through scripts
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# v 1.0, Michael Wuertenberger
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: test_scripts_aarch64_pypi
 
 concurrency:

diff --git a/.github/workflows/test_scripts_packages.yml b/.github/workflows/test_scripts_packages.yml
@@ -1,8 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# GitHub actions for checking the installation of mountwizzard4 packages
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# v 1.0, Michael Wuertenberger
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: test_scripts_packages
 
 concurrency:

diff --git a/.github/workflows/test_scripts_pypi.yml b/.github/workflows/test_scripts_pypi.yml
@@ -1,8 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# GitHub actions for checking the installation of MW4 through scripts
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# v 1.0, Michael Wuertenberger
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: test_scripts_pypi
 
 concurrency:

diff --git a/.github/workflows/unit_macOS.yml b/.github/workflows/unit_macOS.yml
@@ -1,6 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# v1.0, Michael Wuertenberger
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: unit_macOS
 concurrency:
   group: "${{ github.ref }}-${{ github.workflow }}"

diff --git a/.github/workflows/unit_ubuntu.yml b/.github/workflows/unit_ubuntu.yml
@@ -1,6 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# v1.0, Michael Wuertenberger
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: unit_ubuntu
 concurrency:
   group: "${{ github.ref }}-${{ github.workflow }}"

diff --git a/.github/workflows/unit_win.yml b/.github/workflows/unit_win.yml
@@ -1,6 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# v1.1, Michael Wuertenberger
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
+#
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: unit_win
 
 concurrency:

diff --git a/.github/workflows/wheels_20_p38.yml b/.github/workflows/wheels_20_p38.yml
@@ -1,8 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# GitHub actions for running the unit test of the mountwizzard4 package
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# v0.1,  Michael Wuertenberger
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: wheels_20_38
 
 concurrency:

diff --git a/.github/workflows/wheels_22_p310.yml b/.github/workflows/wheels_22_p310.yml
@@ -1,8 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# GitHub actions for running the unit test of the mountwizzard4 package
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# v0.1,  Michael Wuertenberger
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: wheels_22_310
 
 concurrency:

diff --git a/.github/workflows/wheels_22_p39.yml b/.github/workflows/wheels_22_p39.yml
@@ -1,8 +1,20 @@
+############################################################
+# -*- coding: utf-8 -*-
 #
-# GitHub actions for running the unit test of the mountwizzard4 package
+#       #   #  #   #   #    #
+#      ##  ##  #  ##  #    #
+#     # # # #  # # # #    #  #
+#    #  ##  #  ##  ##    ######
+#   #   #   #  #   #       #
 #
-# v0.1,  Michael Wuertenberger
+# Python-based Tool for interaction with the 10micron mounts
+# GUI with PyQT5 for python3
 #
+# written in python3, (c) 2019-2024 by mworion
+# Licence APL2.0
+#
+###########################################################
+
 name: wheels_22_39
 
 concurrency:

diff --git a/docs/.buildinfo b/docs/.buildinfo
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_images/first_run.png b/docs/_images/first_run.png
diff --git a/docs/_images/information.png b/docs/_images/information.png
diff --git a/docs/_images/mac_1.png b/docs/_images/mac_1.png
diff --git a/docs/_images/mac_2.png b/docs/_images/mac_2.png
diff --git a/docs/_images/mac_3.png b/docs/_images/mac_3.png
diff --git a/docs/_images/mountSettlingTime.png b/docs/_images/mountSettlingTime.png
diff --git a/docs/_images/overview.png b/docs/_images/overview.png
diff --git a/docs/_images/python_win_path.png b/docs/_images/python_win_path.png
diff --git a/docs/_images/rpi3_python37.png b/docs/_images/rpi3_python37.png
diff --git a/docs/_images/rpi3_rlancaste.png b/docs/_images/rpi3_rlancaste.png
diff --git a/docs/_images/rpi3_running.png b/docs/_images/rpi3_running.png
diff --git a/docs/_images/sat2_altitude.png b/docs/_images/sat2_altitude.png
diff --git a/docs/_images/sat2_azimuth.png b/docs/_images/sat2_azimuth.png
diff --git a/docs/_images/sat2_dec.png b/docs/_images/sat2_dec.png
diff --git a/docs/_images/sat2_ra.png b/docs/_images/sat2_ra.png
diff --git a/docs/_images/sat2_track.png b/docs/_images/sat2_track.png
diff --git a/docs/_images/sat_altitude.png b/docs/_images/sat_altitude.png
diff --git a/docs/_images/sat_azimuth.png b/docs/_images/sat_azimuth.png
diff --git a/docs/_images/sat_dec.png b/docs/_images/sat_dec.png
diff --git a/docs/_images/sat_ra.png b/docs/_images/sat_ra.png
diff --git a/docs/_images/sat_track.png b/docs/_images/sat_track.png
diff --git a/docs/_images/scale_1_5.png b/docs/_images/scale_1_5.png
diff --git a/docs/_images/scale_dpi48.png b/docs/_images/scale_dpi48.png
diff --git a/docs/_images/scale_normal.png b/docs/_images/scale_normal.png
diff --git a/docs/_images/scripts.png b/docs/_images/scripts.png
diff --git a/docs/_images/setup.png b/docs/_images/setup.png
diff --git a/docs/_images/time.png b/docs/_images/time.png
diff --git a/docs/_images/ubuntu_setup.png b/docs/_images/ubuntu_setup.png
diff --git a/docs/_images/update1.png b/docs/_images/update1.png
diff --git a/docs/_images/update2.png b/docs/_images/update2.png
diff --git a/docs/_images/update3.png b/docs/_images/update3.png
diff --git a/docs/_images/update4.png b/docs/_images/update4.png
diff --git a/docs/_images/versions.png b/docs/_images/versions.png
diff --git a/docs/_images/waitingTime.png b/docs/_images/waitingTime.png
diff --git a/docs/_images/win_1.png b/docs/_images/win_1.png
diff --git a/docs/_images/win_2.png b/docs/_images/win_2.png
diff --git a/docs/_images/win_3.png b/docs/_images/win_3.png
diff --git a/docs/_images/win_a.png b/docs/_images/win_a.png
diff --git a/docs/_images/win_b.png b/docs/_images/win_b.png