Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | docs: Use lumen theme for documentationwip/carlosg/test | Carlos Garnacho | 2021-08-29 | 1 | -0/+1 |
| | | | | | | Do as instructed in their readme and use the tarball URL directly. Not great since it requires network access, but seems failable (using the default theme otherwise), so let's go with that. | ||||
* | ci: Change src/dest dirs for hotdoc documentation | Carlos Garnacho | 2021-08-29 | 3 | -44/+10 |
| | | | | | | 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". | ||||
* | ci: Add intermediate job to build the website before deploying | Carlos Garnacho | 2021-08-29 | 2 | -15/+29 |
| | | | | | | | | | This job allows us to check website output in merge requests, before having it deployed to the gitlab pages. The script that generates the website HTML has been changed to allow specifying the output directory, so it's not always the "public" special directory. | ||||
* | ci: Exclude generated boilerplate in coverage checks | Carlos Garnacho | 2021-08-29 | 1 | -1/+1 |
| | | | | | | We don't care as much about the specific lines of glib-mkenums or gresource generated files that are being tested. Get these out of coverage output. | ||||
* | ci: Isolate coverage job into its own build/test run | Carlos Garnacho | 2021-08-29 | 1 | -2/+5 |
| | | | | | | | | | | Right now we use the result from the build/test jobs on fedora/x86_64, we however do some other things on those trees (e.g. build docs) that triggers Tracker code being run, and confuses the results of gcovr wrt the lines being tested. Separate the coverage CI job to do its own build/test so the other jobs are orthogonal to coverage checks. | ||||
* | ci: Add glib2-doc to fedora image | Carlos Garnacho | 2021-08-29 | 1 | -2/+2 |
| | | | | | This will help generate docs with full links for the glib/gobject types in our API. | ||||
* | build: Make hotdoc target depend on ontology docs | Carlos Garnacho | 2021-08-29 | 1 | -1/+1 |
| | | | | Otherwise it might be built in parallel, which we do not want. | ||||
* | ci: Make Rawhide failable | Carlos Garnacho | 2021-08-29 | 1 | -7/+10 |
| | | | | | This is broken ATM, make it able to fail, and use F34 for all other misc stuff. | ||||
* | docs: Install devhelp files | Carlos Garnacho | 2021-08-29 | 3 | -6/+16 |
| | | | | | This is very clunky at the moment, since we need to shoehorn our own keywords on the devhelp2 file, and install manually. | ||||
* | docs: Generate keywords helper file for markdown documentation | Carlos Garnacho | 2021-08-29 | 2 | -1/+69 |
| | |||||
* | ci: Update fedora image with documentation tools | Carlos Garnacho | 2021-08-29 | 1 | -5/+7 |
| | | | | We now need hotdoc to build docs. | ||||
* | doc: Tweak hotdoc theme | Carlos Garnacho | 2021-08-29 | 6 | -0/+126 |
| | | | | | | | We need to help it a bit, so it can put our ontology note icons side by side, and to include turtle/sparql prism components, since hotdoc ships an ancient version of prism for syntax highlighting that does not observe these formats yet. | ||||
* | docs: Update references to code symbols for hotdoc | Carlos Garnacho | 2021-08-26 | 6 | -37/+37 |
| | | | | These were done with gi-docgen in mind, but we're not going that way. | ||||
* | docs: Move images so they are in a single folder | Carlos Garnacho | 2021-08-26 | 6 | -9/+0 |
| | | | | This is a restriction of Hotdoc. | ||||
* | docs: Fix image locations | Carlos Garnacho | 2021-08-26 | 2 | -4/+4 |
| | |||||
* | docs: Include Nepomuk documentation in hotdoc | Carlos Garnacho | 2021-08-26 | 18 | -496/+159 |
| | | | | Move away from it being in its on gtk-doc build. | ||||
* | docs: Add missing migration doc | Carlos Garnacho | 2021-08-26 | 2 | -2/+8 |
| | |||||
* | docs: Set primary section on all markdown docs | Carlos Garnacho | 2021-08-26 | 12 | -2/+26 |
| | |||||
* | libtracker-sparql: Add missing doc pieces | Carlos Garnacho | 2021-08-26 | 6 | -0/+62 |
| | | | | Necessary to put things together nicely in hotdoc. | ||||
* | src: Remove needless <para> in API doc blurbs | Carlos Garnacho | 2021-08-26 | 5 | -23/+2 |
| | | | | | Not even gtk-doc needs these nowadays, plus they'll mess up with anything we'll port to. | ||||
* | Revert "meson: Add gi-docgen as a subproject" | Carlos Garnacho | 2021-08-26 | 2 | -9/+0 |
| | | | | This reverts commit 4446db1ba422b8f13cc96f75e49fbee7aa88d7d0. | ||||
* | build: Use hotdoc to build documentation | Carlos Garnacho | 2021-08-26 | 6 | -76/+50 |
| | |||||
* | docs: Adapt markdown docs to hotdoc formatting specifics | Carlos Garnacho | 2021-08-26 | 13 | -407/+476 |
| | |||||
* | tools: Adapt ontology docgen tool for hotdoc markdown specifics | Carlos Garnacho | 2021-08-26 | 1 | -3/+7 |
| | |||||
* | docs: Generate examples page with actual examples | Carlos Garnacho | 2021-08-26 | 3 | -2/+46 |
| | | | | Do some string replacement here to include the examples. | ||||
* | docs: Generate base ontology documentation for gi-docgen docs | Carlos Garnacho | 2021-08-26 | 4 | -2/+30 |
| | |||||
* | ontologies: Add separate documentation file for RDFS | Carlos Garnacho | 2021-08-26 | 2 | -0/+13 |
| | | | | | A little help for the new documentation tool, so this ontology is picked up. | ||||
* | docs: Add documentation generation in markdown format | Carlos Garnacho | 2021-08-26 | 5 | -1/+636 |
| | | | | | | This is implemented as separate code that does markdown formatting, there's probably some opportunities for subclassing and text templating, but it can be made prettier later on. | ||||
* | docs: Generalize class hierarchy creation further | Carlos Garnacho | 2021-08-26 | 3 | -33/+56 |
| | | | | Let the caller produce the links in the format it likes. | ||||
* | tools: Rename docgen executable | Carlos Garnacho | 2021-08-26 | 3 | -4/+4 |
| | | | | Give it a more generic name. | ||||
* | docs: Rename code file | Carlos Garnacho | 2021-08-26 | 4 | -3/+3 |
| | | | | | Make the code filename more consistent with the rest of the Tracker tree, and account for multiple writers in the future. | ||||
* | docs: Move all XML generation into a single file | Carlos Garnacho | 2021-08-26 | 4 | -351/+278 |
| | | | | | We'll want to have multiple writers, so put all XML together in a single file. | ||||
* | docs: Refactor common utils to separate file | Carlos Garnacho | 2021-08-26 | 4 | -365/+435 |
| | | | | | We'll want to generate different document formats, the printing of the hierarchy tree can be abstraced into a common helper. | ||||
* | docs: Rewrite data model of documentation tool | Carlos Garnacho | 2021-08-26 | 13 | -996/+881 |
| | | | | | | | | | | | | | Instead of parsing ontology TTL by itself, use 2 in-memory TrackerSparqlConnections for the task, one to load .description files, and another with an empty database. With these in place, the ontology is fully introspectable, we can then query these to fill in our information about the defined classes and properties. One advantage here is that we avoid purpose-specific Turtle file parsers and unify this on the sparql library. | ||||
* | docs: Build again manpages and ontology docs | Carlos Garnacho | 2021-08-26 | 3 | -3/+18 |
| | | | | Manpages aren't going anywhere, and ontology docs not yet. | ||||
* | docs: Delete gtk-doc remnants | Carlos Garnacho | 2021-08-26 | 4 | -429/+0 |
| | | | | These files only served for gtk-doc purposes, drop them. | ||||
* | docs: Finish porting of tutorial docs to Markdown | Carlos Garnacho | 2021-08-26 | 3 | -431/+66 |
| | |||||
* | docs: Drop "migrating 1.x to 2.x" docs | Carlos Garnacho | 2021-08-26 | 1 | -57/+0 |
| | | | | | If there's anything left to be ported, perhaps it's time to admit some docs won't help it. | ||||
* | docs: Port "migrating 2.x to 3.x" to markdown | Carlos Garnacho | 2021-08-26 | 3 | -201/+162 |
| | |||||
* | docs: Port "examples" to markdown | Carlos Garnacho | 2021-08-26 | 3 | -138/+99 |
| | |||||
* | docs: Port "defining ontologies" documentation to markdown | Carlos Garnacho | 2021-08-26 | 22 | -471/+392 |
| | |||||
* | docs: Port "sparql and tracker" documentation to Markdown | Carlos Garnacho | 2021-08-26 | 3 | -300/+257 |
| | |||||
* | docs: Port "sparql functions" doc to markdown | Carlos Garnacho | 2021-08-26 | 3 | -467/+350 |
| | |||||
* | docs: Port "performance" docs to markdown | Carlos Garnacho | 2021-08-26 | 3 | -142/+104 |
| | |||||
* | docs: Port "implementation limits" document to markdown | Carlos Garnacho | 2021-08-26 | 3 | -132/+85 |
| | |||||
* | docs: Move overview to markdown | Carlos Garnacho | 2021-08-26 | 3 | -89/+60 |
| | |||||
* | meson: Add gi-docgen as a subproject | Daniele Nicolodi | 2021-08-26 | 1 | -0/+6 |
| | | | | Currently this is the preferred way to integrate it with the built system. | ||||
* | docs: Generate reference manual with gi-docgen | Daniele Nicolodi | 2021-08-26 | 6 | -93/+371 |
| | |||||
* | meson: Adjust indentation | Daniele Nicolodi | 2021-08-26 | 1 | -1/+1 |
| | |||||
* | Merge branch 'wip/carlosg/uri-id-lookups' into 'master' | Sam Thursfield | 2021-08-26 | 2 | -3/+62 |
|\ | | | | | | | | | libtracker-data: Ensure tracker:id/uri can only look up allowed graphs See merge request GNOME/tracker!461 |