Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.debian.bugs.dist > #1242665 > unrolled thread

Bug#1099403: libamdhip64-doc: Doxygen information is missing

Back to article view | Back to linux.debian.bugs.dist

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  Bug#1099403: libamdhip64-doc: Doxygen information is missing Cordell Bloor <cgmb@slerp.xyz> - 2025-04-19 07:10 +0200

#1242665 — Bug#1099403: libamdhip64-doc: Doxygen information is missing

The rocm-hipamd upstream now uses doxysphinx [1] and rocm-docs-core [2]. 
We can hack around the lack of rocm-docs-core without too much trouble, 
but the lack of doxysphinx is more difficult to handle. The doxysphinx 
package is not available in Trixie, so we'd need a freeze exception to 
use it.

I pushed a cgmb/sphinx-docs branch that uses sphinx to build the rest of 
the documentation, but the API listing is still missing. That's still an 
improvement over the current documentation, so maybe it should be 
included in Trixie? If we wanted to hack around the lack of doxysphinx, 
we'd probably need to add a bit of RST to invoke `.. doxygenindex::` 
from Breathe, like in rocfft allapi.rst.

In the long term, those hacks would be a total pain to maintain. The 
docs have become a definite pain point, so I hope the situation improves 
with the new packages.

Sincerely,
Cory Bloor

[1]: https://tracker.debian.org/pkg/doxysphinx
[2]: https://lists.debian.org/debian-ai/2025/03/msg00107.html
[3]: 
https://salsa.debian.org/rocm-team/rocm-hipamd/-/tree/cgmb/sphinx-docs?ref_type=heads

[toc] | [standalone]

Back to top | Article view | linux.debian.bugs.dist

csiph-web