diff options
author | Carlos Garnacho <carlosg@gnome.org> | 2023-02-26 19:11:08 +0100 |
---|---|---|
committer | Carlos Garnacho <carlosg@gnome.org> | 2023-02-27 09:18:57 +0100 |
commit | d3508bf573b0c537ea8540360f6d80c7a6345ab4 (patch) | |
tree | f795c628ebf4bb11c884b94d5be2f350b0d30e4b /docs | |
parent | 63c29ffd31d40b7a3384572ffa067729c33a1130 (diff) | |
download | tracker-d3508bf573b0c537ea8540360f6d80c7a6345ab4.tar.gz |
docs: Make tutorial a generated doc
In order to move to embedded SVGs for images, we have to be able
to embed them first.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/libtracker-sparql/meson.build | 62 | ||||
-rw-r--r-- | docs/reference/libtracker-sparql/tutorial.md.in (renamed from docs/reference/libtracker-sparql/tutorial.md) | 0 |
2 files changed, 36 insertions, 26 deletions
diff --git a/docs/reference/libtracker-sparql/meson.build b/docs/reference/libtracker-sparql/meson.build index 7c746832d..e49b31d8a 100644 --- a/docs/reference/libtracker-sparql/meson.build +++ b/docs/reference/libtracker-sparql/meson.build @@ -41,7 +41,17 @@ nepomuk_ontology_docs = custom_target('nepomuk-docgen', depend_files: [nepomuk, ontology_introductions], ) -generated_files = [ +generate_images = custom_target( + 'doc-images', + output: 'rdfs:Resource-hierarchy.svg', + command: [ + 'generate-svgs.sh', + graphviz_dot, + meson.current_build_dir(), + ], + depends: [base_ontology_docs, nepomuk_ontology_docs]) + +generated_ontology_files = [ 'xsd-ontology.md.in', 'rdf-ontology.md.in', 'rdfs-ontology.md.in', @@ -59,22 +69,12 @@ generated_files = [ 'osinfo-ontology.md.in', ] -generate_images = custom_target( - 'doc-images', - output: 'rdfs:Resource-hierarchy.svg', - command: [ - 'generate-svgs.sh', - graphviz_dot, - meson.current_build_dir(), - ], - depends: [base_ontology_docs, nepomuk_ontology_docs]) - generated_targets = [] -generated_content = [] +generated_ontology_content = [] -foreach doc : generated_files +foreach doc : generated_ontology_files output_file = doc.replace('.in', '') - generated_content += output_file + generated_ontology_content += output_file generated_targets += custom_target( output_file, output: output_file, @@ -86,19 +86,29 @@ foreach doc : generated_files depends: [base_ontology_docs, nepomuk_ontology_docs, generate_images]) endforeach -examples = custom_target( - 'examples', - input: 'examples.md.in', - output: 'examples.md', - command: [ - 'embed-files.py', - '@INPUT@', - '@OUTPUT@', - ]) +generated_content_files = [ + 'examples.md.in', + 'tutorial.md.in', +] + +generated_content = [] + +foreach doc : generated_content_files + output_file = doc.replace('.in', '') + generated_content += output_file + generated_targets += custom_target( + output_file, + input: doc, + output: output_file, + command: [ + 'embed-files.py', + '@INPUT@', + '@OUTPUT@', + ]) +endforeach overview = ['overview.md'] content = [ - 'tutorial.md', 'ontologies.md', 'sparql-functions.md', 'sparql-and-tracker.md', @@ -110,7 +120,7 @@ content = [ # The TOML gi-docgen configuration wants a list of quoted file names. content_quoted = [] -foreach c : overview + fs.name(examples.full_path()) + content + generated_content +foreach c : overview + generated_content + content + generated_ontology_content content_quoted += '"@0@"'.format(c) endforeach @@ -137,7 +147,7 @@ reference = custom_target( '--content-dir=@0@'.format(meson.current_build_dir()), '@INPUT1@', ], - depends: [tracker_sparql_gir[0], generated_targets, examples], + depends: [tracker_sparql_gir[0], generated_targets], depend_files: [overview, content]) docs_name = 'Tracker-3.0' diff --git a/docs/reference/libtracker-sparql/tutorial.md b/docs/reference/libtracker-sparql/tutorial.md.in index 570046648..570046648 100644 --- a/docs/reference/libtracker-sparql/tutorial.md +++ b/docs/reference/libtracker-sparql/tutorial.md.in |