From 0d0dfa6da09543d001e936232ee06267a2de82d4 Mon Sep 17 00:00:00 2001 From: Mario Limonciello Date: Fri, 11 Jun 2021 23:51:02 -0500 Subject: [PATCH] trivial: set up links between libfwupd and libfwupdplugin --- .circleci/config.yml | 2 +- docs/fwupd.toml.in | 12 +++++++++++- docs/fwupdplugin.toml.in | 15 +++++++++++++-- docs/meson.build | 4 ++++ docs/urlmap.js | 5 +++++ 5 files changed, 34 insertions(+), 4 deletions(-) create mode 100644 docs/urlmap.js diff --git a/.circleci/config.yml b/.circleci/config.yml index 2ab8c6493..bfe99b6ac 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -102,7 +102,7 @@ jobs: git config user.email "info@fwupd.org" git config user.name "Documentation deployment Bot" rm -rf * - cp ../libfwupd* ../*html . -R + cp ../libfwupd* ../*html ../*.js . -R git add . git commit -a --allow-empty -m "Trigger deployment" git push git@github.com:fwupd/fwupd.github.io.git diff --git a/docs/fwupd.toml.in b/docs/fwupd.toml.in index 6f31d5c27..d84191592 100644 --- a/docs/fwupd.toml.in +++ b/docs/fwupd.toml.in @@ -7,7 +7,11 @@ authors = "fwupd Development Team" logo_url = "org.freedesktop.fwupd.svg" license = "LGPL-2.1-or-later" description = "Functionality exported by libfwupd for client applications" -dependencies = [ "GObject-2.0", "Gio-2.0"] +dependencies = [ + "GObject-2.0", + "Gio-2.0", + "Json-1.0" +] devhelp = true search_index = true @@ -21,6 +25,11 @@ search_index = true description = "A modern, easy-to-use VFS API" docs_url = "https://developer.gnome.org/gio/stable/" + [dependencies."Json-1.0"] + name = "Json" + description = "API for efficient parsing and writing of JSON (JavaScript Object Notation) streams" + docs_url = "https://developer.gnome.org/json-glib/stable/" + [theme] name = "basic" show_index_summary = true @@ -33,6 +42,7 @@ base_url = "https://github.com/fwupd/fwupd/blob/master/" content_images = [ "../data/org.freedesktop.fwupd.svg", ] +urlmap_file = "../urlmap.js" [[object]] name = "build_user_agent_system" diff --git a/docs/fwupdplugin.toml.in b/docs/fwupdplugin.toml.in index 074dc0c01..ef468d162 100644 --- a/docs/fwupdplugin.toml.in +++ b/docs/fwupdplugin.toml.in @@ -7,7 +7,13 @@ authors = "fwupd Development Team" logo_url = "org.freedesktop.fwupd.svg" license = "LGPL-2.1-or-later" description = "Functionality available to fwupd plugins" -dependencies = [ "GObject-2.0", "Gio-2.0"] +dependencies = [ + "GObject-2.0", + "Gio-2.0", + "Fwupd-2.0", + "Xmlb-2.0", + "GUsb-1.0" +] devhelp = true search_index = true @@ -21,6 +27,11 @@ search_index = true description = "A modern, easy-to-use VFS API" docs_url = "https://developer.gnome.org/gio/stable/" + [dependencies."Fwupd-2.0"] + name = "Fwupd" + description = "Firmware update daemon client library" + docs_url = "../libfwupd/index.html" + [theme] name = "basic" show_index_summary = true @@ -38,7 +49,7 @@ content_images = [ "architecture-plan.svg", "../data/org.freedesktop.fwupd.svg", ] -urlmap_file = "urlmap.js" +urlmap_file = "../urlmap.js" [[object]] name = "Device" diff --git a/docs/meson.build b/docs/meson.build index 1d1331945..f3fa8659b 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -68,6 +68,10 @@ if get_option('docs') == 'docgen' install_data(['index.html'], install_dir : join_paths(datadir, 'doc', 'fwupd') ) + install_data(['urlmap.js'], + install_dir : join_paths(datadir, 'doc', 'fwupd') + ) + elif get_option('docs') == 'gtkdoc' gnome.gtkdoc( 'fwupd', diff --git a/docs/urlmap.js b/docs/urlmap.js new file mode 100644 index 000000000..0ccc9a6d5 --- /dev/null +++ b/docs/urlmap.js @@ -0,0 +1,5 @@ +baseURLs = [ + [ 'Gio', 'https://people.gnome.org/~ebassi/docs/_build/Gio/' ], + [ 'GObject', 'https://people.gnome.org/~ebassi/docs/_build/GObject/' ], + [ 'Fwupd', '../libfwupd/' ], +]