Update documentation build scripts

Author: MostlyKIGuess

.github/workflows/docs.yml

@@ -19,7 +19,7 @@ jobs:
           sudo apt install -y build-essential sudo git wget curl python3-sphinx rsync
 
           # install sugar-toolkit-gtk3 dependencies
-          sudo apt install -y python-all-dev python3-all-dev libgtk-3-dev
+          sudo apt install -y python-dev-is-python3 python3-dev libgtk-3-dev
           sudo apt install -y libgdk-pixbuf2.0-dev libsm-dev libice-dev librsvg2-dev
           sudo apt install -y libxfixes-dev libxi-dev libx11-dev gettext intltool
           sudo apt install -y libxml-parser-perl x11proto-core-dev libasound2-dev

ci/docs.sh

@@ -19,8 +19,9 @@ sudo make
 
 # make documentation
 show-green "Building documentation"
+sphinx-build -b html doc doc/_build/html
 ./make-doc.sh
-mkdir deploy
+mkdir -p deploy
 cp -r doc/_build/html deploy/sugar3
 touch deploy/.nojekyll
 # create an index.html so that users don't become confused

doc/Makefile

@@ -15,7 +15,7 @@ endif
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) 
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
@@ -52,9 +52,9 @@ clean:
 	rm -rf $(BUILDDIR)/*
 
 html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+    @echo
+    @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

make-doc.sh

@@ -1,4 +1,15 @@
 #!/bin/sh
+set -e
+
+if [ ! -d "src" ]; then
+  echo "Error: ../src directory does not exist."
+  exit 1
+fi
+
+if [ ! -d "doc" ]; then
+  echo "Error: doc directory does not exist."
+  exit 1
+fi
 
 sphinx-apidoc --force --separate --output-dir=doc src
 make -C doc html

src/sugar3/sugar-key-grabber.c

@@ -312,4 +312,4 @@ sugar_key_grabber_is_modifier(SugarKeyGrabber *grabber, guint keycode, guint mas
 	XFreeModifiermap (modmap);
 
 	return is_modifier;
-}
+}