Repository navigation
Conversation
Running ninja gen_docs started to fail with recent versions of Doxygen with the following error: Generating code for/build/liboqs-git/src/liboqs/README.md:96: error: unable to resolve reference to 'algorithms' for \ref command There is a mention to "relative path directory" in the changelog but did not try to understand why this doesn't work now. Simply replacing the relative path with an absolute URL like it is done in the rest of the document solves the issue for me. Signed-off-by: Iyán Méndez Veiga <me@iyanmv.com>
baentsch
left a comment
There was a problem hiding this comment.
Besides noting CI failures, is this really the best solution for a doxygen problem? This seems to break forks and network-disconnected copies/deployments.
|
If this change breaks anything, then the README was already broken because the exact same link is used above: Line 45 in fd44469 This was just a quick fix to restore a broken pipeline compiling from the latest commit. I can try to understand why doxygen doesn't like anymore that relative link. |
|
Okay, so it seems like it is a bug in upstream that was already fixed with doxygen/doxygen@053beab However, I would still keep this small change because I have just double checked and the current relative link is broken anyways. If you check the generated html files, that link doesn't work because docs/algorithms is not included in the output docs. So it is currently broken for both online and offline deployments. |
|
+1 on this fix, since the relative link is a live issue on doxygen An alternative that keeps the link relative (so it works on forks, etc.) would be to add
|
Small change to fix a build problem when generating the docs with
ninja gen_docswith recent versions of Doxygen.