diff --git a/.github/actions/web/action.yaml b/.github/actions/web/action.yaml index 03f226ea9..5ccce0646 100644 --- a/.github/actions/web/action.yaml +++ b/.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 diff --git a/.github/workflows/web.yaml b/.github/workflows/web.yaml index 9f7d37ef4..746e78c93 100644 --- a/.github/workflows/web.yaml +++ b/.github/workflows/web.yaml @@ -15,6 +15,7 @@ on: paths: - 'web/**' - 'shared/liboxide/**' + - 'shared/libblight/**' - '.github/actions/web/**' jobs: web: diff --git a/.gitmodules b/.gitmodules index 0196f22e6..94a2f5787 100644 --- a/.gitmodules +++ b/.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 diff --git a/shared/doxygen-awesome-css b/shared/doxygen-awesome-css new file mode 160000 index 000000000..df88fe4fd --- /dev/null +++ b/shared/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit df88fe4fdd97714fadfd3ef17de0b4401f804052 diff --git a/shared/liboxide/header.html b/shared/doxygen-header.html similarity index 100% rename from shared/liboxide/header.html rename to shared/doxygen-header.html diff --git a/shared/libblight/.gitignore b/shared/libblight/.gitignore new file mode 100644 index 000000000..00ce98c8b --- /dev/null +++ b/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/ diff --git a/shared/libblight/Doxyfile b/shared/libblight/Doxyfile new file mode 100644 index 000000000..c9ff02f50 --- /dev/null +++ b/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 diff --git a/shared/libblight/Makefile b/shared/libblight/Makefile new file mode 100644 index 000000000..5baa44687 --- /dev/null +++ b/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 diff --git a/shared/liboxide/Doxyfile b/shared/liboxide/Doxyfile index 0883299f3..e8d1a7d5e 100644 --- a/shared/liboxide/Doxyfile +++ b/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 diff --git a/shared/liboxide/doxygen-awesome-css b/shared/liboxide/doxygen-awesome-css deleted file mode 160000 index 4cd62308d..000000000 --- a/shared/liboxide/doxygen-awesome-css +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 4cd62308d825fe0396d2f66ffbab45d0e247724c diff --git a/web/src/documentation/api/00_overview.rst b/web/src/documentation/api/00_overview.rst index d49d507e9..fc1310c97 100644 --- a/web/src/documentation/api/00_overview.rst +++ b/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>`__