diff options
author | Carlos Garnacho <carlosg@gnome.org> | 2021-08-29 20:24:29 +0200 |
---|---|---|
committer | Carlos Garnacho <carlosg@gnome.org> | 2021-08-29 22:33:30 +0200 |
commit | c09d1992194ed428d5028d4dfd79b8df0d63a4f1 (patch) | |
tree | f4cb5cf51f4f6253c7745e44870d58d224cb8fbc | |
parent | 9324fefd54f7a0ad6219c144fcaa0369e2f56f8f (diff) | |
download | tracker-c09d1992194ed428d5028d4dfd79b8df0d63a4f1.tar.gz |
ci: Change src/dest dirs for hotdoc documentation
This is now generated/installed in different paths, and we want
to remove the "api-preview" bits of the target URL. Change these
so the documentation is correctly picked up, and looks "official".
-rw-r--r-- | .gitlab-ci.yml | 2 | ||||
-rwxr-xr-x | docs/website/build.py | 18 | ||||
-rw-r--r-- | docs/website/docs/developer.md | 34 |
3 files changed, 10 insertions, 44 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0fb0d6515..99a458342 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -337,7 +337,7 @@ test-website: - | export tracker_commit=$CI_COMMIT_SHA export tracker_miners_commit=$(git -C ./extra/tracker-miners rev-parse HEAD) - ./docs/website/build.py --output=website --api-docs="$install_prefix/share/gtk-doc/html" --tracker-commit=${tracker_commit} --man-pages ./docs/manpages/*.txt ./extra/tracker-miners/docs/manpages/*.txt + ./docs/website/build.py --output=website --api-docs="$install_prefix/share/doc/Tracker/html" --tracker-commit=${tracker_commit} --man-pages ./docs/manpages/*.txt ./extra/tracker-miners/docs/manpages/*.txt artifacts: paths: - website diff --git a/docs/website/build.py b/docs/website/build.py index 629c07b33..e903dcd38 100755 --- a/docs/website/build.py +++ b/docs/website/build.py @@ -192,15 +192,15 @@ def main(): apidocs_src = pathlib.Path(args.api_docs) log.info("Copying API reference documentation from %s", apidocs_src) - apidocs_dest = output_path.joinpath('docs/api-preview') - apidocs_dest.mkdir(parents=True) - for name in ['libtracker-sparql-3', 'ontology-3']: - src = apidocs_src.joinpath(name) - dest = apidocs_dest.joinpath(name) - if not src.exists(): - raise RuntimeError("Expected path {} doesn't exist.".format(src)) - log.info(" - Copying %s to %s (%i files)", src, dest, len(list(src.iterdir()))) - shutil.copytree(src, dest) + apidocs_dest = output_path.joinpath('docs/developer/') + shutil.rmtree(apidocs_dest) + + src = apidocs_src + dest = apidocs_dest + if not src.exists(): + raise RuntimeError("Expected path {} doesn't exist.".format(src)) + log.info(" - Copying %s to %s (%i files)", src, dest, len(list(src.iterdir()))) + shutil.copytree(src, dest) log.info("Adding preview header to API reference documentation") text = apidocs_header(args.tracker_commit) diff --git a/docs/website/docs/developer.md b/docs/website/docs/developer.md index b685541ad..4796167e6 100644 --- a/docs/website/docs/developer.md +++ b/docs/website/docs/developer.md @@ -1,35 +1 @@ # Developer Documentation - -Application and platform developers using Tracker will interact with Tracker -using one or more of the shared libraries it provides: - - * [libtracker-sparql](https://developer.gnome.org/libtracker-sparql/stable/) is - used to read and write data from the Tracker store using SPARQL. - * [libtracker-control](https://developer.gnome.org/libtracker-control/stable/), - is used to manage Tracker daemons. - * [libtracker-miner](https://developer.gnome.org/libtracker-miner/stable/) can - be used if you want to implement a new data provider while reusing existing - Tracker code. - -WARNING: The documention linked above is for out of date verions of Tracker 2.x. -This is due to an [infrastructure -issue](https://gitlab.gnome.org/Infrastructure/library-web/issues/50). See also -[this bug](https://gitlab.gnome.org/GNOME/tracker/-/issues/100). - -The following documentation may be useful: - - * [Tracker ontology documentation](https://developer.gnome.org/ontology/stable/). - * [Tracker documentation on wiki.gnome.org](https://wiki.gnome.org/Projects/Tracker). - -For working on Tracker itself, read the [HACKING.md -file](https://gitlab.gnome.org/GNOME/tracker/-/blob/master/HACKING.md). - -## Preview Documentation - -We provide an online version of the documentation for the latest in-development version -of Tracker. You can browse it here: - - * [libtracker-sparql](../api-preview/libtracker-sparql-3/) - * [ontology](../api-preview/ontology-3/) - -Be aware that some libraries from Tracker 2.0 will not be available for Tracker 3.0. |