trivial: set up links between libfwupd and libfwupdplugin

This commit is contained in:
Mario Limonciello 2021-06-11 23:51:02 -05:00 committed by Richard Hughes
parent be5de229e0
commit 0d0dfa6da0
5 changed files with 34 additions and 4 deletions

View File

@ -102,7 +102,7 @@ jobs:
git config user.email "info@fwupd.org" git config user.email "info@fwupd.org"
git config user.name "Documentation deployment Bot" git config user.name "Documentation deployment Bot"
rm -rf * rm -rf *
cp ../libfwupd* ../*html . -R cp ../libfwupd* ../*html ../*.js . -R
git add . git add .
git commit -a --allow-empty -m "Trigger deployment" git commit -a --allow-empty -m "Trigger deployment"
git push git@github.com:fwupd/fwupd.github.io.git git push git@github.com:fwupd/fwupd.github.io.git

View File

@ -7,7 +7,11 @@ authors = "fwupd Development Team"
logo_url = "org.freedesktop.fwupd.svg" logo_url = "org.freedesktop.fwupd.svg"
license = "LGPL-2.1-or-later" license = "LGPL-2.1-or-later"
description = "Functionality exported by libfwupd for client applications" 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 devhelp = true
search_index = true search_index = true
@ -21,6 +25,11 @@ search_index = true
description = "A modern, easy-to-use VFS API" description = "A modern, easy-to-use VFS API"
docs_url = "https://developer.gnome.org/gio/stable/" 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] [theme]
name = "basic" name = "basic"
show_index_summary = true show_index_summary = true
@ -33,6 +42,7 @@ base_url = "https://github.com/fwupd/fwupd/blob/master/"
content_images = [ content_images = [
"../data/org.freedesktop.fwupd.svg", "../data/org.freedesktop.fwupd.svg",
] ]
urlmap_file = "../urlmap.js"
[[object]] [[object]]
name = "build_user_agent_system" name = "build_user_agent_system"

View File

@ -7,7 +7,13 @@ authors = "fwupd Development Team"
logo_url = "org.freedesktop.fwupd.svg" logo_url = "org.freedesktop.fwupd.svg"
license = "LGPL-2.1-or-later" license = "LGPL-2.1-or-later"
description = "Functionality available to fwupd plugins" 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 devhelp = true
search_index = true search_index = true
@ -21,6 +27,11 @@ search_index = true
description = "A modern, easy-to-use VFS API" description = "A modern, easy-to-use VFS API"
docs_url = "https://developer.gnome.org/gio/stable/" 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] [theme]
name = "basic" name = "basic"
show_index_summary = true show_index_summary = true
@ -38,7 +49,7 @@ content_images = [
"architecture-plan.svg", "architecture-plan.svg",
"../data/org.freedesktop.fwupd.svg", "../data/org.freedesktop.fwupd.svg",
] ]
urlmap_file = "urlmap.js" urlmap_file = "../urlmap.js"
[[object]] [[object]]
name = "Device" name = "Device"

View File

@ -68,6 +68,10 @@ if get_option('docs') == 'docgen'
install_data(['index.html'], install_data(['index.html'],
install_dir : join_paths(datadir, 'doc', 'fwupd') install_dir : join_paths(datadir, 'doc', 'fwupd')
) )
install_data(['urlmap.js'],
install_dir : join_paths(datadir, 'doc', 'fwupd')
)
elif get_option('docs') == 'gtkdoc' elif get_option('docs') == 'gtkdoc'
gnome.gtkdoc( gnome.gtkdoc(
'fwupd', 'fwupd',

5
docs/urlmap.js Normal file
View File

@ -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/' ],
]