add sphinx to appimage build

.github/workflows/appimage-build.yml

@@ -35,7 +35,7 @@ jobs:
             libxkbcommon0 \
             libgtk-3-bin libglib2.0-bin glib-networking shared-mime-info gsettings-desktop-schemas \
             liblua5.4-dev libpci-dev libperl-dev libssl-dev libayatana-appindicator3-dev \
-            perl python3 python3-minimal python3-dev python3-cffi mono-devel desktop-file-utils \
+            perl python3 python3-minimal python3-dev python3-cffi python3-sphinx mono-devel desktop-file-utils \
             breeze-gtk-theme \
             patchelf file curl
 

.github/workflows/windows-build.yml

@@ -40,6 +40,7 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install cffi
           python -m pip install zstandard
+          python -m pip install sphinx
 
           $ProgressPreference = 'SilentlyContinue'
           function Download-WithRetry {

docs/_theme/basicstrap/layout.html

@@ -135,7 +135,9 @@
     {{ js_tag(scriptfile) }}
   {%- endif -%}
 {%- endfor %}
+{%- if theme_theme_preview|tobool %}
 <script type="text/javascript" src="{{ pathto('_static/js/jquery.cookie.min.js', 1) }}"></script>
+{%- endif %}
 <script type="text/javascript" src="{{ pathto('_static/js/basicstrap.js', 1) }}"></script>
 <script type="text/javascript">
   DOCUMENTATION_OPTIONS.FILE_SUFFIX = DOCUMENTATION_OPTIONS.FILE_SUFFIX || '.html';

docs/build-docs.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+
+import os
+import shutil
+import subprocess
+import sys
+
+
+def prune_unused_local_assets(output_dir):
+    index_path = os.path.join(output_dir, "index.html")
+
+    try:
+        with open(index_path, "r", encoding="utf-8") as index_file:
+            index_html = index_file.read()
+    except OSError:
+        return
+
+    if "bootswatch-" not in index_html:
+        for bootstrap_version in ("bootstrap2", "bootstrap3"):
+            css_dir = os.path.join(
+                output_dir, "_static", "css", bootstrap_version
+            )
+            if not os.path.isdir(css_dir):
+                continue
+
+            for filename in os.listdir(css_dir):
+                if filename.startswith("bootswatch-") and filename.endswith(".css"):
+                    os.remove(os.path.join(css_dir, filename))
+
+    if "jquery.cookie.min.js" not in index_html:
+        js_dir = os.path.join(output_dir, "_static", "js")
+        for filename in ("jquery.cookie.min.js", "jquery.cookie-1.4.1.min.js"):
+            path = os.path.join(js_dir, filename)
+            if os.path.isfile(path):
+                os.remove(path)
+
+
+def main():
+    if len(sys.argv) != 4:
+        raise SystemExit("usage: build-docs.py SOURCE_DIR OUTPUT_DIR STAMP_FILE")
+
+    source_dir = os.path.abspath(sys.argv[1])
+    output_dir = os.path.abspath(sys.argv[2])
+    stamp_file = os.path.abspath(sys.argv[3])
+    doctree_dir = output_dir + ".doctrees"
+
+    shutil.rmtree(output_dir, ignore_errors=True)
+    shutil.rmtree(doctree_dir, ignore_errors=True)
+    os.makedirs(output_dir, exist_ok=True)
+
+    subprocess.run(
+        [
+            sys.executable,
+            "-m",
+            "sphinx",
+            "-b",
+            "html",
+            "-d",
+            doctree_dir,
+            source_dir,
+            output_dir,
+        ],
+        check=True,
+    )
+
+    prune_unused_local_assets(output_dir)
+
+    with open(stamp_file, "w", encoding="utf-8") as stamp:
+        stamp.write("built\n")
+
+
+if __name__ == "__main__":
+    main()

docs/install-docs.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+
+import os
+import shutil
+import sys
+
+
+def main():
+    if len(sys.argv) != 4:
+        raise SystemExit("usage: install-docs.py STAMP_FILE SOURCE_DIR DATADIR")
+
+    _, source_dir, datadir = sys.argv[1:]
+    source_dir = os.path.abspath(source_dir)
+
+    if not os.path.isfile(sys.argv[1]):
+        raise SystemExit("documentation build did not produce its stamp file")
+    if not os.path.isfile(os.path.join(source_dir, "index.html")):
+        raise SystemExit("documentation build did not produce index.html")
+
+    if os.path.isabs(datadir):
+        destdir = os.environ.get("DESTDIR", "")
+        if destdir:
+            data_root = os.path.join(destdir, datadir.lstrip("/\\"))
+        else:
+            data_root = datadir
+    else:
+        data_root = os.path.join(os.environ["MESON_INSTALL_DESTDIR_PREFIX"], datadir)
+
+    destination = os.path.join(data_root, "doc", "zoitechat", "html")
+    shutil.rmtree(destination, ignore_errors=True)
+    os.makedirs(os.path.dirname(destination), exist_ok=True)
+    shutil.copytree(source_dir, destination)
+
+
+if __name__ == "__main__":
+    main()

flatpak/net.zoite.Zoitechat.json

@@ -59,6 +59,7 @@
       ],
       "config-opts": [
         "-Ddbus-service-use-appid=true",
+        "-Dinstall-docs=false",
         "-Dwith-perl=perl",
         "-Dwith-python=python3",
         "-Dwith-lua=lua"

meson.build

@@ -35,6 +35,9 @@ config_h.set_quoted('PACKAGE_NAME', meson.project_name())
 config_h.set_quoted('GETTEXT_PACKAGE', 'zoitechat')
 config_h.set_quoted('LOCALEDIR', join_paths(get_option('prefix'),
                                  get_option('datadir'), 'locale'))
+config_h.set_quoted('ZOITECHAT_DOCDIR',
+  join_paths(get_option('prefix'), get_option('datadir'), 'doc', 'zoitechat', 'html')
+)
 config_h.set10('ENABLE_NLS', true)
 config_h.set_quoted('ZOITECHAT_DATADIR', join_paths(get_option('prefix'), get_option('datadir')))
 
@@ -161,6 +164,41 @@ foreach ldflag : test_ldflags
 endforeach
 add_project_link_arguments(global_ldflags, language: 'c')
 
+if get_option('install-docs')
+  docs_python = find_program('python3', 'python')
+  docs_sphinx = run_command(docs_python, '-c', 'import sphinx', check: false)
+  if docs_sphinx.returncode() != 0
+    error('Sphinx is required to build the local HTML documentation. Install Sphinx or configure with -Dinstall-docs=false.')
+  endif
+
+  docs_source_dir = join_paths(meson.source_root(), 'docs')
+  docs_output_dir = join_paths(meson.build_root(), 'docs-html')
+  docs_build_script = join_paths(docs_source_dir, 'build-docs.py')
+  docs_install_script = join_paths(docs_source_dir, 'install-docs.py')
+
+  docs_target = custom_target(
+    'html-documentation',
+    output: 'html-documentation.stamp',
+    command: [
+      docs_python,
+      docs_build_script,
+      docs_source_dir,
+      docs_output_dir,
+      '@OUTPUT@',
+    ],
+    build_by_default: true,
+    build_always_stale: true,
+  )
+
+  meson.add_install_script(
+    docs_python,
+    docs_install_script,
+    docs_target,
+    docs_output_dir,
+    get_option('datadir'),
+  )
+endif
+
 subdir('src')
 if get_option('plugin')
   subdir('plugins')

meson_options.txt

@@ -33,6 +33,9 @@ option('install-appdata', type: 'boolean',
 option('install-plugin-metainfo', type: 'boolean', value: false,
   description: 'Installs metainfo files for enabled plugins, useful when distros create split packages'
 )
+option('install-docs', type: 'boolean', value: true,
+  description: 'Build and install the local HTML documentation'
+)
 
 # Plugins
 option('with-checksum', type: 'boolean',

packaging/fedora/zoitechat.spec

@@ -15,6 +15,7 @@ BuildRequires:  perl
 BuildRequires:  perl-devel
 BuildRequires:  python3
 BuildRequires:  python3-cffi
+BuildRequires:  python3-sphinx
 BuildRequires:  publicsuffix-list
 BuildRequires:  xwayland-run
 BuildRequires:  weston
@@ -94,6 +95,7 @@ xwfb-run -- /usr/bin/meson test -C %{_vpath_builddir} --num-processes %{_smp_bui
 %{_datadir}/icons/hicolor/scalable/apps/net.zoite.Zoitechat.svg
 %{_datadir}/metainfo/net.zoite.Zoitechat.appdata.xml
 %{_datadir}/metainfo/net.zoite.Zoitechat*.metainfo.xml
+%{_datadir}/doc/zoitechat/html/
 %dir %{_libdir}/zoitechat
 %dir %{_libdir}/zoitechat/plugins
 %dir %{_libdir}/zoitechat/python

src/common/cfgfiles.c

@@ -430,8 +430,6 @@ const struct prefs vars[] =
 	{"gui_lang", P_OFFINT (hex_gui_lang), TYPE_INT},
 	{"gui_mode_buttons", P_OFFINT (hex_gui_mode_buttons), TYPE_BOOL},
 	{"gui_mode_buttons_inline", P_OFFINT (hex_gui_mode_buttons_inline), TYPE_BOOL},
-	{"gui_onboarding_disable", P_OFFINT (hex_gui_onboarding_disable), TYPE_BOOL},
-	{"gui_onboarding_pending", P_OFFINT (hex_gui_onboarding_pending), TYPE_BOOL},
 	{"gui_pane_divider_position", P_OFFINT (hex_gui_pane_divider_position), TYPE_INT},
 	{"gui_pane_left_size", P_OFFINT (hex_gui_pane_left_size), TYPE_INT},
 	{"gui_pane_right_size", P_OFFINT (hex_gui_pane_right_size), TYPE_INT},

src/common/servlist.c

@@ -191,8 +191,6 @@ struct defaultserver
 	gboolean ssl;
 };
 
-static gboolean servlist_needs_onboarding_flag;
-
 static const struct defaultserver def[] =
 {
 	{"2600net",	0},
@@ -1183,10 +1181,7 @@ servlist_load (void)
 
 	fp = zoitechat_fopen_file ("servlist.conf", "r", 0);
 	if (!fp)
-	{
-		servlist_needs_onboarding_flag = TRUE;
 		return FALSE;
-	}
 
 	while (fgets (buf, sizeof (buf) - 2, fp))
 	{
@@ -1250,7 +1245,6 @@ servlist_load (void)
 			net = servlist_net_add (buf + 2, NULL, FALSE);
 	}
 	fclose (fp);
-	servlist_needs_onboarding_flag = (network_list == NULL);
 
 	return TRUE;
 }
@@ -1259,16 +1253,8 @@ void
 servlist_init (void)
 {
 	if (!network_list)
-	{
+		if (!servlist_load ())
-		if (!servlist_load () || !network_list)
 			servlist_load_defaults ();
-	}
-}
-
-gboolean
-servlist_needs_onboarding (void)
-{
-	return servlist_needs_onboarding_flag;
 }
 
 /* check if a charset is known by Iconv */
@@ -1409,7 +1395,6 @@ servlist_save (void)
 	}
 
 	fclose (fp);
-	servlist_needs_onboarding_flag = FALSE;
 	return TRUE;
 }
 

src/common/servlist.h

@@ -93,7 +93,6 @@ extern GSList *network_list;
 #define IRC_DEFAULT_CHARSET		"UTF-8 (Unicode)"
 
 void servlist_init (void);
-gboolean servlist_needs_onboarding (void);
 int servlist_save (void);
 int servlist_cycle (server *serv);
 void servlist_connect (session *sess, ircnet *net, gboolean join);

src/common/zoitechat.h

@@ -134,8 +134,6 @@ struct zoitechatprefs
 	unsigned int hex_gui_join_dialog;
 	unsigned int hex_gui_mode_buttons;
 	unsigned int hex_gui_mode_buttons_inline;
-	unsigned int hex_gui_onboarding_disable;
-	unsigned int hex_gui_onboarding_pending;
 	unsigned int hex_gui_quit_dialog;
 	/* unsigned int hex_gui_single; */
 	unsigned int hex_gui_slist_fav;

src/fe-gtk/menu.c

@@ -1796,9 +1796,50 @@ menu_ctcpguiopen (void)
 	editlist_gui_open (NULL, NULL, ctcp_list, buf, "ctcpreply", "ctcpreply.conf", ctcp_help);
 }
 
+static char *
+menu_find_local_docs (void)
+{
+	char *path;
+
+#ifdef WIN32
+	char *base_path;
+
+	base_path = g_win32_get_package_installation_directory_of_module (NULL);
+	if (!base_path)
+		return NULL;
+
+	path = g_build_filename (base_path, "share", "doc", "zoitechat", "html", "index.html", NULL);
+	g_free (base_path);
+#else
+	const char *appdir;
+
+	appdir = g_getenv ("APPDIR");
+	if (appdir && *appdir)
+		path = g_build_filename (appdir, "usr", "share", "doc", "zoitechat", "html", "index.html", NULL);
+	else
+		path = g_build_filename (ZOITECHAT_DOCDIR, "index.html", NULL);
+#endif
+
+	if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
+		return path;
+
+	g_free (path);
+	return NULL;
+}
+
 static void
 menu_docs (GtkWidget *wid, gpointer none)
 {
+	char *path;
+
+	path = menu_find_local_docs ();
+	if (path)
+	{
+		fe_open_url (path);
+		g_free (path);
+		return;
+	}
+
 	fe_open_url ("https://docs.zoitechat.org/en/latest/");
 }
 

src/fe-gtk/meson.build

@@ -95,7 +95,6 @@ zoitechat_gtk_ldflags = []
 if host_machine.system() == 'windows'
   zoitechat_gtk_sources += 'notifications/notification-windows.c'
   zoitechat_gtk_deps += cc.find_library('dwmapi', required: true)
-  zoitechat_gtk_deps += cc.find_library('winhttp', required: true)
   zoitechat_theme_deps += cc.find_library('dwmapi', required: true)
 
 else

src/fe-gtk/setup.c

@@ -648,9 +648,6 @@ static const char *const proxyuse[] =
 
 static const setting network_settings[] =
 {
-        {ST_HEADER,     N_("Startup"), 0, 0, 0, 0},
-        {ST_TOGGLE,     N_("Disable first-run assistant"), P_OFFINTNL(hex_gui_onboarding_disable), 0, 0, 0},
-
         {ST_HEADER,     N_("Your Address"), 0, 0, 0, 0},
         {ST_ENTRY,      N_("Bind to:"), P_OFFSETNL(hex_net_bind_host), 0, 0, sizeof prefs.hex_net_bind_host},
         {ST_LABEL,      N_("Only useful for computers with multiple addresses.")},