[tracker/wip/carlosg/hotdoc: 1/3] docs: Install devhelp files
- From: Carlos Garnacho <carlosg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tracker/wip/carlosg/hotdoc: 1/3] docs: Install devhelp files
- Date: Fri, 20 Aug 2021 15:21:22 +0000 (UTC)
commit cd43473cd20d7fae83164cf6790adf44e24c6ff5
Author: Carlos Garnacho <carlosg gnome org>
Date: Thu Aug 19 00:49:32 2021 +0200
docs: Install devhelp files
This is very clunky at the moment, since we need to shoehorn our own
keywords on the devhelp2 file, and install manually.
.gitlab-ci.yml | 2 +-
docs/reference/libtracker-sparql/install-devhelp.sh | 15 +++++++++++----
docs/reference/libtracker-sparql/meson.build | 5 ++++-
3 files changed, 16 insertions(+), 6 deletions(-)
---
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 9cbccfb56..794b31227 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -192,7 +192,7 @@ check-code-style:
- meson . build -Ddocs=$([ -z "$NO_DOCS" ] && echo "true" || echo "false") -Db_lto=true
-Db_coverage=true -Dsystemd_user_services=false -Dtests_tap_protocol=true --prefix /usr
- ninja -C build
- |
- if [ -z "$NO_DOCS" ]; then ninja -C build docs/reference/libtracker-sparql/tracker-doc; fi
+ if [ -z "$NO_DOCS" ]; then ninja -C build docs/reference/libtracker-sparql/Tracker-doc; fi
artifacts:
expire_in: 1 day
paths:
diff --git a/docs/reference/libtracker-sparql/install-devhelp.sh
b/docs/reference/libtracker-sparql/install-devhelp.sh
index 685ae99c2..6f396a55b 100755
--- a/docs/reference/libtracker-sparql/install-devhelp.sh
+++ b/docs/reference/libtracker-sparql/install-devhelp.sh
@@ -2,11 +2,18 @@
cd ${MESON_BUILD_ROOT}/docs/reference/libtracker-sparql/
+docs_name=$1
+echo $docs_name
+docs_path="${docs_name}-doc/devhelp/books/${docs_name}"
+echo $docs_path
+devhelp_file="${docs_path}/*.devhelp2"
+echo $devhelp_file
+
# Step 1. Build devhelp documentation (we let meson do this)
-# hotdoc run --conf-file tracker-doc.json --devhelp-activate
+# hotdoc run --conf-file '${docs_name}-doc.json' --devhelp-activate
# Step 2. Fix .devhelp2 file so it contains keywords from out ontologies
-cat *doc/devhelp/books/tracker/*.devhelp2 | sed "s/<\/functions>//" - | sed "s/<\/book>//" - >fixed.devhelp2
+cat $devhelp_file | sed "s/<\/functions>//" - | sed "s/<\/book>//" - >fixed.devhelp2
for i in *-ontology.keywords
do
@@ -14,8 +21,8 @@ do
done
echo -e " </functions>\n</book>" >>fixed.devhelp2
-mv fixed.devhelp2 *doc/devhelp/books/tracker/*.devhelp2
+mv fixed.devhelp2 $devhelp_file
# Step 3. Install all files
mkdir -p ${MESON_INSTALL_PREFIX}/share/devhelp/books
-cp -a *doc/devhelp/books/tracker ${MESON_INSTALL_PREFIX}/share/devhelp/books/
+cp -a $docs_path ${MESON_INSTALL_PREFIX}/share/devhelp/books/
diff --git a/docs/reference/libtracker-sparql/meson.build b/docs/reference/libtracker-sparql/meson.build
index 44c1ccdcc..72c9eda75 100644
--- a/docs/reference/libtracker-sparql/meson.build
+++ b/docs/reference/libtracker-sparql/meson.build
@@ -63,7 +63,8 @@ foreach ext: required_hotdoc_extensions
endif
endforeach
-hotdoc.generate_doc('tracker',
+docs_name = 'Tracker'
+hotdoc.generate_doc(docs_name,
project_version: tracker_version,
languages: [ 'c', 'python', 'javascript' ],
gi_c_sources: [libtracker_sparql_c_sources, libtracker_sparql_c_public_headers,
libtracker_sparql_remote_c_sources],
@@ -80,3 +81,5 @@ hotdoc.generate_doc('tracker',
devhelp_activate: true,
install: true,
)
+
+meson.add_install_script('install-devhelp.sh', docs_name)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]