From 216e57879755877920cd205fd1196e7ce8057518 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Mon, 4 Sep 2023 11:16:26 +0200
Subject: [PATCH 01/15] MAINT: blocking login window

---
 dtool_lookup_gui/views/login_window.ui | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/dtool_lookup_gui/views/login_window.ui b/dtool_lookup_gui/views/login_window.ui
index 1f28ac71..922545d1 100644
--- a/dtool_lookup_gui/views/login_window.ui
+++ b/dtool_lookup_gui/views/login_window.ui
@@ -5,7 +5,9 @@
   <template class="LoginWindow" parent="GtkWindow">
     <property name="can-focus">False</property>
     <property name="default-width">400</property>
-    <property name="default-height">300</property>
+    <property name="default-height">200</property>
+    <property name="resizable">False</property>
+    <property name="modal">True</property>
     <signal name="delete-event" handler="on_delete" swapped="no"/>
     <child>
       <!-- n-columns=3 n-rows=3 -->

From 91a25240bb3a890360c1abf2ffc3670ef306a326 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Mon, 4 Sep 2023 11:37:59 +0200
Subject: [PATCH 02/15] TST: test against renew-token action as well

---
 test/test_app.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/test/test_app.py b/test/test_app.py
index 9b7c74eb..421024a6 100644
--- a/test/test_app.py
+++ b/test/test_app.py
@@ -43,6 +43,7 @@ async def test_app_list_actions(app):
     assert set(app.list_actions()) == set([
         'toggle-logging',
         'reset-config',
+        'renew-token',
         'set-loglevel',
         'set-logfile',
         'export-config',

From da8777f0c1c91b4c92a05c646a9c598dda0aac00 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 14:31:04 +0200
Subject: [PATCH 03/15] DOC: initial sphinx and readthedocs stub

---
 .readthedocs.yaml     | 13 +++++++++++++
 docs/Makefile         | 20 ++++++++++++++++++++
 docs/make.bat         | 35 +++++++++++++++++++++++++++++++++++
 docs/requirements.txt |  2 ++
 docs/source/api.rst   |  7 +++++++
 docs/source/conf.py   | 35 +++++++++++++++++++++++++++++++++++
 docs/source/index.rst | 13 +++++++++++++
 7 files changed, 125 insertions(+)
 create mode 100644 .readthedocs.yaml
 create mode 100644 docs/Makefile
 create mode 100644 docs/make.bat
 create mode 100644 docs/requirements.txt
 create mode 100644 docs/source/api.rst
 create mode 100644 docs/source/conf.py
 create mode 100644 docs/source/index.rst

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..9138a7fe
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/source/conf.py
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 00000000..d0c3cbf1
--- /dev/null
+++ b/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)
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 00000000..9534b018
--- /dev/null
+++ b/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
+
+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% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..53fc1f32
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1
diff --git a/docs/source/api.rst b/docs/source/api.rst
new file mode 100644
index 00000000..ac98e08d
--- /dev/null
+++ b/docs/source/api.rst
@@ -0,0 +1,7 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   dtool-lookup-gui
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 00000000..eeb8043e
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,35 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'dtool-lookup-gui'
+copyright = '2023, Hoermann'
+author = 'Hoermann'
+
+release = '0.1'
+version = '0.1.0'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 00000000..1a2e6027
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,13 @@
+Welcome to the dtool-lookup-gui's documentation!
+================================================
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+
+   api

From 9e690c8b452680b5ace6a4dfe6ffa77b4a2fb49f Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 14:48:22 +0200
Subject: [PATCH 04/15] TST: tests modified

---
 test/test_app.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/test/test_app.py b/test/test_app.py
index 421024a6..1a02229a 100644
--- a/test/test_app.py
+++ b/test/test_app.py
@@ -7,6 +7,7 @@
 from dtool_lookup_gui.views.log_window import LogWindow
 from dtool_lookup_gui.views.login_window import LoginWindow
 from dtool_lookup_gui.views.main_window import MainWindow
+from dtool_lookup_gui.views.server_versions_dialog import ServerVersionsDialog
 
 logger = logging.getLogger(__name__)
 
@@ -35,7 +36,7 @@ async def test_app_id(app):
 @pytest.mark.asyncio
 async def test_app_window_types(app):
     window_types = [type(win) for win in app.get_windows()]
-    assert set(window_types) == set([AboutDialog, SettingsDialog, LogWindow, LoginWindow, MainWindow])
+    assert set(window_types) == set([AboutDialog, SettingsDialog, ServerVersionsDialog, LogWindow, LoginWindow, MainWindow])
 
 
 @pytest.mark.asyncio

From 90380b75e0262ab6f9386078b65e9c7d63add8f7 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 14:53:51 +0200
Subject: [PATCH 05/15] TST: removed LoginWindow from tests

---
 test/test_app.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test/test_app.py b/test/test_app.py
index 1a02229a..b51b4cf1 100644
--- a/test/test_app.py
+++ b/test/test_app.py
@@ -36,7 +36,7 @@ async def test_app_id(app):
 @pytest.mark.asyncio
 async def test_app_window_types(app):
     window_types = [type(win) for win in app.get_windows()]
-    assert set(window_types) == set([AboutDialog, SettingsDialog, ServerVersionsDialog, LogWindow, LoginWindow, MainWindow])
+    assert set(window_types) == set([AboutDialog, SettingsDialog, ServerVersionsDialog, LogWindow, MainWindow])
 
 
 @pytest.mark.asyncio

From e05715d43e68a2deb5cdbbef288d4eb4f12bf61f Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 15:07:24 +0200
Subject: [PATCH 06/15] DOC: updated license headers, alphabetical author list
 script

---
 LICENSE-MIT.md                                |  1 -
 dtool_lookup_gui/main.py                      |  3 +-
 dtool_lookup_gui/models/datasets.py           |  3 +-
 dtool_lookup_gui/views/login_window.py        | 24 +++++++++++
 dtool_lookup_gui/views/main_window.py         |  3 +-
 .../views/s3_configuration_dialog.py          |  3 +-
 .../views/server_versions_dialog.py           | 24 +++++++++++
 dtool_lookup_gui/views/settings_dialog.py     |  3 +-
 maintenance/authors_alphabetical.py           | 40 +++++++++++++++++++
 setup.py                                      |  2 +-
 10 files changed, 99 insertions(+), 7 deletions(-)
 create mode 100644 maintenance/authors_alphabetical.py

diff --git a/LICENSE-MIT.md b/LICENSE-MIT.md
index f0a95791..353d0bd8 100644
--- a/LICENSE-MIT.md
+++ b/LICENSE-MIT.md
@@ -17,4 +17,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
diff --git a/dtool_lookup_gui/main.py b/dtool_lookup_gui/main.py
index 78f325cb..dd85f0bd 100644
--- a/dtool_lookup_gui/main.py
+++ b/dtool_lookup_gui/main.py
@@ -1,5 +1,6 @@
 #
-# Copyright 2021-2022 Johannes Laurin Hörmann
+# Copyright 2021-2023 Johannes Laurin Hörmann
+#           2023 Ashwin Vazhappilly
 #           2021 Lars Pastewka
 #
 # ### MIT license
diff --git a/dtool_lookup_gui/models/datasets.py b/dtool_lookup_gui/models/datasets.py
index 144006b4..8d8400b2 100644
--- a/dtool_lookup_gui/models/datasets.py
+++ b/dtool_lookup_gui/models/datasets.py
@@ -1,5 +1,6 @@
 #
-# Copyright 2021-2022 Johannes Laurin Hörmann
+# Copyright 2023 Ashwin Vazhappilly
+#           2021-2023 Johannes Laurin Hörmann
 #           2020-2021 Lars Pastewka
 #
 # ### MIT license
diff --git a/dtool_lookup_gui/views/login_window.py b/dtool_lookup_gui/views/login_window.py
index 3267f00e..b3139104 100644
--- a/dtool_lookup_gui/views/login_window.py
+++ b/dtool_lookup_gui/views/login_window.py
@@ -1,3 +1,27 @@
+#
+# Copyright 2023 Johannes Laurin Hörmann
+#           2023 Ashwin Vazhappilly
+#
+# ### MIT license
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
 import logging
 import os
 import dtoolcore
diff --git a/dtool_lookup_gui/views/main_window.py b/dtool_lookup_gui/views/main_window.py
index 5a7bf09b..ac431969 100644
--- a/dtool_lookup_gui/views/main_window.py
+++ b/dtool_lookup_gui/views/main_window.py
@@ -1,5 +1,6 @@
 #
-# Copyright 2021-2022 Johannes Laurin Hörmann
+# Copyright 2021-2023 Johannes Laurin Hörmann
+#           2023 Ashwin Vazhappilly
 #           2021 Lars Pastewka
 #
 # ### MIT license
diff --git a/dtool_lookup_gui/views/s3_configuration_dialog.py b/dtool_lookup_gui/views/s3_configuration_dialog.py
index a3a9bb77..2d4642e2 100644
--- a/dtool_lookup_gui/views/s3_configuration_dialog.py
+++ b/dtool_lookup_gui/views/s3_configuration_dialog.py
@@ -1,5 +1,6 @@
 #
-# Copyright 2021 Lars Pastewka
+# Copyright 2022 Johannes Laurin Hörmann
+#           2021 Lars Pastewka
 #
 # ### MIT license
 #
diff --git a/dtool_lookup_gui/views/server_versions_dialog.py b/dtool_lookup_gui/views/server_versions_dialog.py
index 835625a8..0a9378cc 100644
--- a/dtool_lookup_gui/views/server_versions_dialog.py
+++ b/dtool_lookup_gui/views/server_versions_dialog.py
@@ -1,3 +1,27 @@
+#
+# Copyright 2023 Ashwin Vazhappilly
+#           2023 Johannes Laurin Hörmann
+#
+# ### MIT license
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
 import asyncio
 import logging
 import os
diff --git a/dtool_lookup_gui/views/settings_dialog.py b/dtool_lookup_gui/views/settings_dialog.py
index 6c54a38c..1aafe923 100644
--- a/dtool_lookup_gui/views/settings_dialog.py
+++ b/dtool_lookup_gui/views/settings_dialog.py
@@ -1,5 +1,6 @@
 #
-# Copyright 2021-2022 Johannes Laurin Hörmann
+# Copyright 2021-2023 Johannes Laurin Hörmann
+#           2023 Ashwin Vazhappilly
 #           2021 Lars Pastewka
 #
 # ### MIT license
diff --git a/maintenance/authors_alphabetical.py b/maintenance/authors_alphabetical.py
new file mode 100644
index 00000000..f353baea
--- /dev/null
+++ b/maintenance/authors_alphabetical.py
@@ -0,0 +1,40 @@
+#
+# Copyright 2023 Johannes Laurin Hörmann
+#
+# ### MIT license
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+
+import os
+import sys
+root = os.path.dirname(sys.argv[0])
+
+
+def read_authors(fn):
+    return {email.strip('<>'): name for name, email in
+            [line.rsplit(maxsplit=1) for line in open(fn, 'r')]}
+
+
+authors = read_authors('{}/../AUTHORS'.format(root))
+
+authors_alphabetical = sorted(list(set(authors.values())))
+
+print(', '.join(authors_alphabetical))
diff --git a/setup.py b/setup.py
index c01b8a9c..9fe09cf6 100644
--- a/setup.py
+++ b/setup.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2020-2022 Johannes Laurin Hörmann
+# Copyright 2020-2023 Johannes Laurin Hörmann
 #           2020-2021 Lars Pastewka
 #           2020 Antoine Sanner
 #

From 5b62506e44c6a5b36f35232a33b6b4c6ca82cb39 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 15:27:57 +0200
Subject: [PATCH 07/15] MAINT: gitignore

---
 .gitignore | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.gitignore b/.gitignore
index a39ef851..1018cb3f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,6 +7,8 @@ __pycache__
 *egg-info
 /build
 /dist
+/docs/build
+/docs/source/generated
 /dtool_lookup_gui/version.py
 /tests/*.png
 /helpers/*.png

From cc8260e6e1e418450b0ccb62e20b7e9bacb9ea7d Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 16:08:08 +0200
Subject: [PATCH 08/15] DOC: Auto-generate and auto-include a few things

---
 .github/dependabot.yml       |  5 +++++
 docs/requirements.txt        |  1 +
 docs/source/api.rst          |  2 +-
 docs/source/changelog.rst    |  2 ++
 docs/source/conf.py          | 25 +++++++++++++++++++++----
 docs/source/contributing.rst |  2 ++
 docs/source/index.rst        |  3 +++
 docs/source/readme.rst       |  1 +
 8 files changed, 36 insertions(+), 5 deletions(-)
 create mode 100644 docs/source/changelog.rst
 create mode 100644 docs/source/contributing.rst
 create mode 100644 docs/source/readme.rst

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index aa1efa04..2e45f5fa 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -22,3 +22,8 @@ updates:
     directory: "/pyinstaller"
     schedule:
       interval: "daily"
+
+  - package-ecosystem: "pip"
+    directory: "/docs"
+    schedule:
+      interval: "daily"
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 53fc1f32..953e51ec 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,2 +1,3 @@
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
+myst-parser==2.0.0
diff --git a/docs/source/api.rst b/docs/source/api.rst
index ac98e08d..e19eafc0 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -4,4 +4,4 @@ API
 .. autosummary::
    :toctree: generated
 
-   dtool-lookup-gui
+   dtool_lookup_gui
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
new file mode 100644
index 00000000..9f448a2b
--- /dev/null
+++ b/docs/source/changelog.rst
@@ -0,0 +1,2 @@
+.. include:: ../../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/source/conf.py b/docs/source/conf.py
index eeb8043e..6c9d0e29 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -1,13 +1,29 @@
 # Configuration file for the Sphinx documentation builder.
+import os
+import sys
+
+root = os.path.dirname(sys.argv[0])
+
+def read_authors(fn):
+    return {email.strip('<>'): name for name, email in
+            [line.rsplit(maxsplit=1) for line in open(fn, 'r')]}
+
+authors = read_authors('{}/../../AUTHORS'.format(root))
+
+authors_alphabetical = sorted(list(set(authors.values())))
 
 # -- Project information
 
 project = 'dtool-lookup-gui'
-copyright = '2023, Hoermann'
-author = 'Hoermann'
+copyright = '2023, livMatS'
+author = ', '.join(authors_alphabetical)
+
+import dtool_lookup_gui
+version = dtool_lookup_gui.__version__
+release = dtool_lookup_gui.__version__
 
-release = '0.1'
-version = '0.1.0'
+# release = '0.1'
+# version = '0.1.0'
 
 # -- General configuration
 
@@ -17,6 +33,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'myst_parser'
 ]
 
 intersphinx_mapping = {
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
new file mode 100644
index 00000000..7a661a30
--- /dev/null
+++ b/docs/source/contributing.rst
@@ -0,0 +1,2 @@
+.. include:: ../../CONTRIBUTING.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 1a2e6027..2e154603 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -10,4 +10,7 @@ Contents
 
 .. toctree::
 
+   readme
+   contributing
+   changelog
    api
diff --git a/docs/source/readme.rst b/docs/source/readme.rst
new file mode 100644
index 00000000..a6210d3d
--- /dev/null
+++ b/docs/source/readme.rst
@@ -0,0 +1 @@
+.. include:: ../../README.rst

From bd878b095d0cc9c323c2aa464251673d1c01b605 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 16:58:06 +0200
Subject: [PATCH 09/15] DOC: provide relative images

---
 .gitignore          |  1 +
 docs/source/conf.py | 21 +++++++++++++++++++++
 2 files changed, 22 insertions(+)

diff --git a/.gitignore b/.gitignore
index 1018cb3f..2db1db30 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,6 +9,7 @@ __pycache__
 /dist
 /docs/build
 /docs/source/generated
+/docs/source/data
 /dtool_lookup_gui/version.py
 /tests/*.png
 /helpers/*.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 6c9d0e29..119cfa05 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -2,6 +2,22 @@
 import os
 import sys
 
+# -- Prepare
+
+import shutil
+import os
+
+# Define the source and destination paths for images
+data_source_dir = os.path.join(os.path.dirname(__file__), '..', '..', 'data')
+data_destination_dir = os.path.join(os.path.dirname(__file__), 'data')
+
+# Copy images from source to destination
+shutil.rmtree(data_destination_dir, ignore_errors=True)  # Remove existing destination directory
+shutil.copytree(data_source_dir, data_destination_dir)  # Copy images
+
+# Add the new image path to the HTML static path
+# html_static_path.append(data_destination_dir)
+
 root = os.path.dirname(sys.argv[0])
 
 def read_authors(fn):
@@ -50,3 +66,8 @@ def read_authors(fn):
 
 # -- Options for EPUB output
 epub_show_urls = 'footnote'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['data']

From 10d55736dcc2846e94102bc71c0a566f74086663 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 17:08:02 +0200
Subject: [PATCH 10/15] DOC: modified sphinx conf for rtd

---
 docs/source/conf.py | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 119cfa05..283d36b5 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -7,9 +7,11 @@
 import shutil
 import os
 
+root = os.path.dirname(__file__)
+
 # Define the source and destination paths for images
-data_source_dir = os.path.join(os.path.dirname(__file__), '..', '..', 'data')
-data_destination_dir = os.path.join(os.path.dirname(__file__), 'data')
+data_source_dir = os.path.join(root, '..', '..', 'data')
+data_destination_dir = os.path.join(root, 'data')
 
 # Copy images from source to destination
 shutil.rmtree(data_destination_dir, ignore_errors=True)  # Remove existing destination directory
@@ -18,13 +20,13 @@
 # Add the new image path to the HTML static path
 # html_static_path.append(data_destination_dir)
 
-root = os.path.dirname(sys.argv[0])
+# root = os.path.dirname(sys.argv[0])
 
 def read_authors(fn):
     return {email.strip('<>'): name for name, email in
             [line.rsplit(maxsplit=1) for line in open(fn, 'r')]}
 
-authors = read_authors('{}/../../AUTHORS'.format(root))
+authors = read_authors(os.path.join(root, '..', '..', 'AUTHORS'))
 
 authors_alphabetical = sorted(list(set(authors.values())))
 

From 19ef4109c0ceb6e12f63c9e82e7b62b513ca60a1 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 17:49:15 +0200
Subject: [PATCH 11/15] DOC: modified sphinx conf for rtd

---
 docs/source/conf.py | 18 ++----------------
 1 file changed, 2 insertions(+), 16 deletions(-)

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 283d36b5..d36ac6a7 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -1,6 +1,4 @@
 # Configuration file for the Sphinx documentation builder.
-import os
-import sys
 
 # -- Prepare
 
@@ -17,24 +15,12 @@
 shutil.rmtree(data_destination_dir, ignore_errors=True)  # Remove existing destination directory
 shutil.copytree(data_source_dir, data_destination_dir)  # Copy images
 
-# Add the new image path to the HTML static path
-# html_static_path.append(data_destination_dir)
-
-# root = os.path.dirname(sys.argv[0])
-
-def read_authors(fn):
-    return {email.strip('<>'): name for name, email in
-            [line.rsplit(maxsplit=1) for line in open(fn, 'r')]}
-
-authors = read_authors(os.path.join(root, '..', '..', 'AUTHORS'))
-
-authors_alphabetical = sorted(list(set(authors.values())))
-
 # -- Project information
 
 project = 'dtool-lookup-gui'
 copyright = '2023, livMatS'
-author = ', '.join(authors_alphabetical)
+author = 'Antoine Sanner, Ashwin Vazhappilly, Johannes Laurin Hörmann, Lars Pastewka, Michal Rössler, Wolfram Nöhring'
+
 
 import dtool_lookup_gui
 version = dtool_lookup_gui.__version__

From a9efadfc62e8d5229c70f81bb4270a4a70a13d96 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 18:07:39 +0200
Subject: [PATCH 12/15] DOC: install package itself on readthedocs

---
 .readthedocs.yaml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 9138a7fe..98df9fab 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -8,6 +8,8 @@ build:
 python:
   install:
     - requirements: docs/requirements.txt
+    - method: pip
+      path: .
 
 sphinx:
   configuration: docs/source/conf.py

From cc87f7527660a56528551a0f81303339ceaceb28 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 18:13:44 +0200
Subject: [PATCH 13/15] DOC: install apt gir package on readthedocs ubuntu
 runner

---
 .readthedocs.yaml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 98df9fab..86bcfb44 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -4,6 +4,8 @@ build:
   os: "ubuntu-22.04"
   tools:
     python: "3.10"
+  apt_packages:
+    - "gir1.2-gtksource-4"
 
 python:
   install:

From 1b9df99ed006bcc95c4a7762371e594607576b7e Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 18:18:43 +0200
Subject: [PATCH 14/15] DOC: install apt libgirepository1.0-dev package on
 readthedocs ubuntu runner

---
 .readthedocs.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 86bcfb44..003c9830 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -6,6 +6,7 @@ build:
     python: "3.10"
   apt_packages:
     - "gir1.2-gtksource-4"
+    - "libgirepository1.0-dev"
 
 python:
   install:

From 0027ee7606ce9a3d00f7127d98df6335b6fc9256 Mon Sep 17 00:00:00 2001
From: Johannes Laurin Hoermann <johannes.hoermann@imtek.uni-freiburg.de>
Date: Wed, 13 Sep 2023 18:20:28 +0200
Subject: [PATCH 15/15] CI: bumped macos worker version

---
 .github/workflows/build-on-macos.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/build-on-macos.yml b/.github/workflows/build-on-macos.yml
index 88b1913e..233d7bdd 100644
--- a/.github/workflows/build-on-macos.yml
+++ b/.github/workflows/build-on-macos.yml
@@ -6,7 +6,7 @@ on:
 jobs:
   build:
 
-    runs-on: macos-10.15
+    runs-on: macos-11
       
     steps: