Peter Hutterer
57e7cd7972
doc: drop the git depth from the hugo theme
...
We need a specific SHA so let's not risk that one being outside that
depth that we clone to.
2023-11-08 16:04:33 +10:00
Peter Hutterer
5909717700
doc: use a specific revision of the hugo template
...
Upstream commit 1250bf30a8c2e3c1bfac285489bc63f2c395b641 somehow breaks
things. Doesn't affect hugo v0.111 (F39) but it does break on F38 on
v0.101.
Let's not waste more time debugging this, hardcode the template and in a
few weeks time we can switch to F39 as the build host.
2023-10-11 13:09:31 +10:00
Peter Hutterer
43b383ebdb
doc/protocol: fix some hugo warnings
...
WARN 2023/10/11 12:41:19 "_index.md": WARNING you must call the ref /
relref shortcode with '% %' instead of '< >' to work correctly for the
anchor target attribute
2023-10-11 12:42:47 +10:00
Peter Hutterer
cc053155a5
doc: change the doxygen oeffis group to liboeffis
...
This way the links are consistent with the libei/libeis groups.
2023-05-31 16:11:57 +10:00
Peter Hutterer
df268d618a
libei 1.0.0rc1
2023-05-17 12:28:12 +10:00
Peter Hutterer
b37868e904
doc/protocol: fix link to the liboeffis API docs
2023-05-09 09:56:29 +10:00
Peter Hutterer
5a1caca643
doc/protocol: fix the link to the C libraries section
2023-05-09 09:53:51 +10:00
Peter Hutterer
5b1b5aec1a
proto: replace pointer/keyboard/touchscreen with a generic "interface" event
...
Since these events are merely notifications of a single object, we can make
this more generic. This allows us to introduce future capabilities without
having to bump the seat.
2023-04-06 13:57:18 +10:00
Peter Hutterer
c5aa2c0b60
doc/proto: address a few documentation issues
...
A few clarifications as suggested by Benjamin Tissoires.
2023-03-17 14:03:32 +10:00
Peter Hutterer
8954d96227
Remove empty trailing newlines from all files
2023-03-13 08:52:08 +10:00
Peter Hutterer
37f4351a67
doc/proto: add a page for the ei-scanner
...
In case someone is actually planning to use that one
2023-03-10 14:25:59 +10:00
Peter Hutterer
d44de4e73e
doc/proto: add a link to the git repo and issues page
2023-03-09 14:49:03 +10:00
Peter Hutterer
e8765f3042
doc/proto: add a page describing the libraries
...
Now that the API doc is behind a link, let's make it a bit more
prominent to find.
2023-03-09 14:28:30 +10:00
Peter Hutterer
2665224461
doc/proto: mirror the required directory structure
...
Might as well make this easier for us locally.
2023-03-09 14:28:30 +10:00
Peter Hutterer
3bcece1923
doc/proto: remove now unused files
...
Obsolete since 5258a559eb
2023-03-09 13:43:43 +10:00
Peter Hutterer
6b7424e821
doc/proto: fix a bug with the pages script
...
Removing the chapter pages means the directory no longer exists, so we
manually have to mkdir it.
2023-03-08 16:07:00 +10:00
Peter Hutterer
5258a559eb
doc/proto: remove the embedded docs from the proto, use static pages instead
2023-03-08 11:09:58 +10:00
Peter Hutterer
56004836b9
proto: add the context-type attribute to events and requests
...
This allows us to mark/filter requests and events that are only
available on a given context type.
2023-03-08 09:01:03 +10:00
Peter Hutterer
fb5b607c13
doc/proto: put a standard blurb in for the destructor-type requests
...
Should eventually have a separate protocol documentation section for
this and point to it, but this will do for now.
2023-03-07 19:29:27 +10:00
Peter Hutterer
59ab84669f
doc/proto: add some basic index pages
...
Better than the placeholders...
2023-03-07 19:22:00 +10:00
Peter Hutterer
ef430fceb0
doc/proto: add the generator script to the input files
...
So meson tracks the dependency better
2023-03-07 19:07:46 +10:00
Peter Hutterer
f97aa73c7c
doc/proto: sort pages by occurrence in the protocol file
2023-03-07 19:05:52 +10:00
Peter Hutterer
8fad365f37
doc: split protocol and api builds into separate meson options
2023-03-07 15:26:36 +10:00
Peter Hutterer
2cf6df9cd0
meson: hook up the protocol documentation via meson
...
Since we want the generated documentation to be useful on-disk, drop the
baseURL and switch to relativeURLs = true for hugo.
This is arguably a bit nasty in that it git clones the theme into the
build directory. But oh well...
2023-03-07 14:14:58 +10:00
