Add initial framework for generating libblight documentation

.github/actions/web/action.yaml

@@ -31,3 +31,7 @@ runs:
       shell: bash
       run: |
         cd shared/liboxide && make prod
+    - name: Generate libblight docs
+      shell: bash
+      run: |
+        cd shared/libblight && make prod

.github/workflows/web.yaml

@@ -15,6 +15,7 @@ on:
     paths:
       - 'web/**'
       - 'shared/liboxide/**'
+      - 'shared/libblight/**'
       - '.github/actions/web/**'
 jobs:
   web:

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "shared/liboxide/doxygen-awesome-css"]
-	path = shared/liboxide/doxygen-awesome-css
+[submodule "shared/doxygen-awesome-css"]
+	path = shared/doxygen-awesome-css
 	url = https://github.com/jothepro/doxygen-awesome-css.git

shared/libblight/.gitignore

@@ -0,0 +1,74 @@
+# This file is used to ignore files which are generated
+# ----------------------------------------------------------------------------
+
+*~
+*.autosave
+*.a
+*.core
+*.moc
+*.o
+*.obj
+*.orig
+*.rej
+*.so
+*.so.*
+*_pch.h.cpp
+*_resource.rc
+*.qm
+.#*
+*.*#
+core
+!core/
+tags
+.DS_Store
+.directory
+*.debug
+*.prl
+*.app
+moc_*.cpp
+ui_*.h
+qrc_*.cpp
+Thumbs.db
+*.res
+*.rc
+/.qmake.cache
+/.qmake.stash
+
+# qtcreator generated files
+*.pro.user*
+
+# xemacs temporary files
+*.flc
+
+# Vim temporary files
+.*.swp
+
+# Visual Studio generated files
+*.ib_pdb_index
+*.idb
+*.ilk
+*.pdb
+*.sln
+*.suo
+*.vcproj
+*vcproj.*.*.user
+*.ncb
+*.sdf
+*.opensdf
+*.vcxproj
+*vcxproj.*
+
+# MinGW generated files
+*.Debug
+*.Release
+
+# Python byte code
+*.pyc
+
+# Binaries
+# --------
+*.dll
+*.exe
+
+html/
+latex/

shared/libblight/Doxyfile

@@ -0,0 +1,20 @@
+PROJECT_NAME = libblight
+GENERATE_QHP = YES
+GENERATE_LATEX = NO
+QCH_FILE = libblight.qch
+QHP_NAMESPACE = libblight
+QHP_VIRTUAL_FOLDER = doc
+QHG_LOCATION = qhelpgenerator
+GENERATE_TREEVIEW = YES
+HTML_EXTRA_STYLESHEET = ../doxygen-awesome-css/doxygen-awesome.css \
+                        ../doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
+                        ../doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css
+HTML_EXTRA_FILES = ../doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
+                   ../doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
+                   ../doxygen-awesome-css/doxygen-awesome-paragraph-link.js
+HTML_HEADER = ../doxygen-header.html
+PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
+HIDE_UNDOC_MEMBERS = YES
+HIDE_UNDOC_CLASSES = YES
+MACRO_EXPANSION = YES
+EXAMPLE_PATH = examples

shared/libblight/Makefile

@@ -0,0 +1,20 @@
+DIST=../../web/dist/libblight
+
+all: prod
+
+html:
+	doxygen Doxyfile
+
+$(DIST): html
+	cp -r html $(DIST)
+
+prod: $(DIST)
+
+dev: clean prod
+	while inotifywait -re close_write,create,delete .; do $(MAKE) clean prod; done
+
+clean:
+	rm -rf $(DIST)
+	rm -rf html
+
+.PHONY: all prod dev clean

shared/liboxide/Doxyfile

@@ -6,13 +6,13 @@ QHP_NAMESPACE = liboxide
 QHP_VIRTUAL_FOLDER = doc
 QHG_LOCATION = qhelpgenerator
 GENERATE_TREEVIEW = YES
-HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
-                        doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
-                        doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css
-HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
-                   doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
-                   doxygen-awesome-css/doxygen-awesome-paragraph-link.js
-HTML_HEADER = header.html
+HTML_EXTRA_STYLESHEET = ../doxygen-awesome-css/doxygen-awesome.css \
+                        ../doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
+                        ../doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css
+HTML_EXTRA_FILES = ../doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
+                   ../doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
+                   ../doxygen-awesome-css/doxygen-awesome-paragraph-link.js
+HTML_HEADER = ../header.html
 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
 HIDE_UNDOC_MEMBERS = YES
 HIDE_UNDOC_CLASSES = YES

web/src/documentation/api/00_overview.rst

@@ -40,3 +40,11 @@ Oxide also produces a shared library that can be used for application developmen
 not yet fully encompass the full API provide through D-Bus, but will slowly work towards feature parity.
 
 `You can find the documentation here <../../liboxide/index.html>`__
+
+
+Libblight Shared Library
+========================
+
+Oxide provides a shared library for interacting with the display server.
+
+`You can find the documentation here <../../libblight/index.html>`__