Commit graph

5 commits

Author SHA1 Message Date
Simon McVittie
264b5ab484 doc: Use the top-level index.html as the table of contents for Devhelp
Now that we have this table of contents, we might as well use it.

Signed-off-by: Simon McVittie <smcv@debian.org>
2024-10-29 17:49:44 +00:00
Simon McVittie
397f9789e6 doc: Use api/html to link to Doxygen docs in Devhelp index
Now that we're installing the Doxygen documentation in a subdirectory,
the Devhelp index needs to reflect that.

Fixes: 522633b4 "cmake: install api docs in html subdir"
Fixes: f546ddd9 "meson: Install Doxygen docs as api/html/*.html"
Signed-off-by: Simon McVittie <smcv@debian.org>
2024-10-29 17:49:44 +00:00
Simon McVittie
fa92263920 doxygen_to_devhelp: Produce Devhelp index format v2
The old version-1 format is deprecated and now produces warnings.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106186
Reviewed-by: Philip Withnall <withnall@endlessm.com>
[smcv: Add the .devhelp2 file to .gitignore as suggested]
Signed-off-by: Simon McVittie <smcv@collabora.com>
2018-04-23 17:44:09 +01:00
Simon McVittie
c84ac8b1ef doxygen_to_devhelp: Make the API reference the front page
The tutorial is not necessarily a great entry point for the libdbus
documentation: it's infrequently updated, and we should probably have
the "If you use this low-level API directly, you're signing up for some
pain" message from the API reference show up in devhelp more immediately.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106186
Reviewed-by: Philip Withnall <withnall@endlessm.com>
[smcv: Add longer commit message with rationale]
Signed-off-by: Simon McVittie <smcv@collabora.com>
2018-04-23 17:39:21 +01:00
Simon McVittie
1edc077257 Add doxygen_to_devhelp.xsl (from Fedora, via Debian)
Originally committed by Matthias Clasen <mclasen@fedoraproject.org>.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=13495
Bug-Debian: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=454142
2011-01-14 12:45:46 +00:00