summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorCarlos Garnacho <carlosg@gnome.org>2021-08-03 11:58:19 +0200
committerCarlos Garnacho <carlosg@gnome.org>2021-08-26 14:04:24 +0200
commit94fb923756647bfcebb834efbba4aacb317b13a9 (patch)
tree789f4744e06df52f0541aed72c7a12b1a482fa98 /docs/reference
parentcd682ae01eec613eff084588d15719a392400f05 (diff)
downloadtracker-94fb923756647bfcebb834efbba4aacb317b13a9.tar.gz
build: Use hotdoc to build documentation
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/libtracker-sparql/meson.build55
-rw-r--r--docs/reference/libtracker-sparql/sitemap.txt18
-rw-r--r--docs/reference/libtracker-sparql/tracker-sparql.toml.in41
3 files changed, 44 insertions, 70 deletions
diff --git a/docs/reference/libtracker-sparql/meson.build b/docs/reference/libtracker-sparql/meson.build
index 14321c810..d616dc1f2 100644
--- a/docs/reference/libtracker-sparql/meson.build
+++ b/docs/reference/libtracker-sparql/meson.build
@@ -48,34 +48,31 @@ generated_content = [
'nrl-ontology.md',
]
-# The TOML gi-docgen configuration wants a list of quoted file names.
-_quoted = []
-foreach c : content + generated_content
- _quoted += '"@0@"'.format(c)
-endforeach
+required_hotdoc_extensions = [
+ 'gi-extension',
+ 'devhelp-extension',
+ 'syntax-highlighting-extension',
+]
-gidocgen_conf = configuration_data()
-gidocgen_conf.set('version', meson.project_version())
-gidocgen_conf.set('content', ','.join(_quoted))
-gidocgen_toml = configure_file(input: 'tracker-sparql.toml.in', output: 'tracker-sparql.toml', configuration: gidocgen_conf)
+foreach ext: required_hotdoc_extensions
+ if not hotdoc.has_extensions(ext)
+ error('Documentation enabled but HotDoc extension "@0@" is missing'.format(ext))
+ endif
+endforeach
-custom_target(
- 'docgen',
- input: [ gidocgen_toml, tracker_sparql_gir[0] ],
- output: 'docs',
- command: [
- gidocgen,
- 'generate',
- '--quiet',
- #'--add-include-path=@0@'.format(meson.current_build_dir() / '../../../gtk'),
- '--config=@INPUT0@',
- '--output-dir=@OUTPUT@',
- #'--no-namespace-dir',
- '--content-dir=@0@'.format(meson.current_source_dir()),
- '--content-dir=@0@'.format(meson.current_build_dir()),
- '--content-dir=@0@'.format(icon_images_base),
- '@INPUT1@',
- ],
- depends: [tracker_sparql_gir[0], base_ontology_docs, examples],
- depend_files: [ content ],
- build_by_default: true)
+hotdoc.generate_doc('tracker',
+ 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],
+ gi_sources: [tracker_sparql_gir[0].full_path()],
+ sitemap: 'sitemap.txt',
+ index: 'index.md',
+ gi_index: 'gi-index.md',
+ gi_smart_index: true,
+ gi_c_source_roots: [sparqlinc],
+ dependencies: [tracker_sparql_dep, glib, gobject],
+ extra_assets: [join_paths(meson.current_source_dir(), 'images')],
+ syntax_highlighting_activate: true,
+ devhelp_activate: true,
+ install: true,
+)
diff --git a/docs/reference/libtracker-sparql/sitemap.txt b/docs/reference/libtracker-sparql/sitemap.txt
new file mode 100644
index 000000000..3cdf7fdd6
--- /dev/null
+++ b/docs/reference/libtracker-sparql/sitemap.txt
@@ -0,0 +1,18 @@
+index.md
+ overview.md
+ examples.md
+ tutorial.md
+ ontologies.md
+ base-ontology.md
+ xsd-ontology.md
+ dc-ontology.md
+ rdf-ontology.md
+ rdfs-ontology.md
+ nrl-ontology.md
+ defining-ontologies.md
+ gi-index
+ sparql-functions.md
+ implementation.md
+ limits.md
+ performance.md
+ sparql-and-tracker.md
diff --git a/docs/reference/libtracker-sparql/tracker-sparql.toml.in b/docs/reference/libtracker-sparql/tracker-sparql.toml.in
deleted file mode 100644
index feaa736be..000000000
--- a/docs/reference/libtracker-sparql/tracker-sparql.toml.in
+++ /dev/null
@@ -1,41 +0,0 @@
-[library]
-version = "@version@"
-browse_url = "https://gitlab.gnome.org/GNOME/tracker/"
-repository_url = "https://gitlab.gnome.org/GNOME/tracker.git"
-website_url = "https://gnome.pages.gitlab.gnome.org/tracker/"
-authors = "Tracker Development Team"
-# logo_url =
-license = "GPL-2.1-or-later"
-description = "Tracker"
-dependencies = [ "GObject-2.0", ]
-devhelp = true
-search_index = true
-
- [dependencies."GObject-2.0"]
- name = "GObject"
- description = "The base type system library"
- docs_url = "https://developer.gnome.org/gobject/stable"
-
-[theme]
-name = "basic"
-show_index_summary = true
-show_class_hierarchy = true
-
-[source-location]
-base_url = "https://gitlab.gnome.org/GNOME/tracker/-/blob/master/"
-
-[extra]
-content_files = [
- @content@
-]
-content_images = [
- "images/icon-deprecated.svg",
- "images/icon-fulltextindexed.svg",
- "images/icon-multivalue.svg",
- "images/icon-notify.svg",
- "images/icon-superproperty.svg",
- "images/triple-graph-1.png",
- "images/triple-graph-2.png",
- "images/triple-graph-3.png",
-]
-# urlmap_file = "urlmap.js"