Add installation and releasenotes sections to the user manual.

.gitignore

@@ -11,3 +11,4 @@ srcdoc/
 pglabAll.pro.user.4.8-pre1
 *.user
 /pglabAll.pro.user*
+/public/

.gitlab-ci.yml

@@ -8,25 +8,34 @@ cache:
     - "$CI_PROJECT_DIR/pip-cache"
   key: "$CI_PROJECT_ID"
 
+.install_sphinx:
+  before_script:
+  - pip install -U sphinx
+  - pip install -U sphinx-theme-pd
+  - pip install -U reno[sphinx]
+
+
 test-docs:
   stage: test
+  extends:
+  - .install_sphinx
   script:
-  - pip install -U sphinx
+  - sphinx-build -b html docs userdocs
-  - pip install -U sphinx-theme-pd
+  artifacts:
-  - sphinx-build -b html docs public
+    paths:
+    - userdocs
   only:
   - branches
-  except:
-  - main
 
-pages:
+deploy:
   stage: deploy
+  extends:
+  - .install_sphinx
   script:
-  - pip install -U sphinx
-  - pip install -U sphinx-theme-pd
   - sphinx-build -b html docs public
   artifacts:
     paths:
     - public
   only:
-  - main
+  - tags
+

docs/conf.py

@@ -22,7 +22,7 @@ copyright = '2021-2022, Eelke Klein'
 author = 'Eelke Klein'
 
 # The full version, including alpha/beta/rc tags
-release = 'https://eelke.gitlab.io/pgLab/'
+# release = '1.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,6 +31,7 @@ release = 'https://eelke.gitlab.io/pgLab/'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+'reno.sphinxext'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -54,4 +55,4 @@ html_theme_path = [sphinx_theme_pd.get_html_theme_path()]
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []

docs/index.rst

@@ -10,13 +10,12 @@ pgLab User Manual
    :maxdepth: 2
    :caption: Contents:
 
+   releasenotes
+   installation
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`search`
 
-Fork this project
-==================
-
-* https://eelke.gitlab.io/pgLab/

docs/installation.rst

@@ -0,0 +1,16 @@
+============
+Installation
+============
+
+Currently only binaries for Windows 64-bit are provided.
+
+-------
+Windows
+-------
+
+Downloads can be found `here <https://eelkeklein.stackstorage.com/s/E9xkMGQDFjHv5XN3>`_.
+
+Unpack the contents of the 7zip archive to a folder of your choosing for instance
+`C:\\Program files\\pgLab`. You can run the pgLab.exe from there. If it is complaining
+about missing files this is probably because the required Visual C++ Runtime has
+not yet been installed on your machine you can get it from `microsoft <https://aka.ms/vs/17/release/vc_redist.x64.exe>`_.

docs/releasenotes.rst

@@ -0,0 +1,5 @@
+============
+Releasenotes
+============
+
+.. release-notes::

pglab/About.cpp

@@ -8,7 +8,7 @@ void ShowAboutDialog(QWidget *parent)
     QString pgLabVersionString = "0.2";
     QString releaseNotesUrl = "file:///" + QCoreApplication::applicationDirPath() + "\\releasenotes.html";
     QString year = QString::fromLatin1(__DATE__, 11).right(4);
-    QMessageBox::about(parent, "pgLab " + pgLabVersionString, QMessageBox::tr(
+    QMessageBox::about(parent, "pgLab", QMessageBox::tr(
               "<h1>Version %3</h1>"
               "<p><a href=\"%2\">Releasenotes</a></p>"
               "<p>Copyrights 2016-%1, Eelke Klein, All Rights Reserved.</p>"

pglab/ConnectionManagerWindow.cpp

@@ -3,13 +3,13 @@
 #include "ui_ConnectionManagerWindow.h"
 #include "MasterController.h"
 #include "ConnectionController.h"
+#include "ConnectionListModel.h"
+#include <QDesktopServices>
+#include <QDir>
 #include <QMessageBox>
 #include <QStandardItemModel>
-#include "ConnectionListModel.h"
-
-
-#include <QDir>
 #include <QStandardPaths>
+#include <QUrl>
 
 ConnectionManagerWindow::ConnectionManagerWindow(MasterController *master, QWidget *parent)
 	: QMainWindow(parent)
@@ -109,3 +109,9 @@ void ConnectionManagerWindow::on_actionAbout_triggered()
     ShowAboutDialog(this);
 }
 
+
+void ConnectionManagerWindow::on_actionManual_triggered()
+{
+    QDesktopServices::openUrl(QString("https://eelke.gitlab.io/pgLab/#pglab-user-manual"));
+}
+

pglab/ConnectionManagerWindow.h

@@ -41,6 +41,8 @@ private slots:
 
     void on_actionAbout_triggered();
 
+    void on_actionManual_triggered();
+
 private:
 	Ui::ConnectionManagerWindow *ui;
 	MasterController *m_masterController;

pglab/ConnectionManagerWindow.ui

@@ -34,6 +34,7 @@
      <string>Fi&amp;le</string>
     </property>
     <addaction name="actionAbout"/>
+    <addaction name="actionManual"/>
     <addaction name="actionQuit_application"/>
    </widget>
    <addaction name="menuFile"/>
@@ -175,6 +176,11 @@ QToolButton {
     <string>About</string>
    </property>
   </action>
+  <action name="actionManual">
+   <property name="text">
+    <string>Manual</string>
+   </property>
+  </action>
  </widget>
  <resources>
   <include location="resources.qrc"/>

releasenotes/config.yaml

@@ -0,0 +1,2 @@
+---
+encoding: utf8

releasenotes/notes/docs-include-releasenotes-53aca515c5c124fd.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Release notes are now included in the user manual.