Closed praveksharma closed 5 months ago
Looks good to me. :) Thanks for this
@Martyrshot I forgot to mark the draft PR to ready for review, sorry about that. Merging is blocked till the changes get another approval.
If we were to rename the section title from Linux/macOS
to Linux and macOS
would that result in a shortcode that is compatible with both Doxygen and Github?
If we were to rename the section title from
Linux/macOS
toLinux and macOS
would that result in a shortcode that is compatible with both Doxygen and Github?
I considered that. Since both #linuxmacOS
and #linux/macOS
(I didn't state this explicitly but #linux/macos
does not work) I think the issue is the upper case letters in macOS and not the /.
If we were to rename the section title from
Linux/macOS
toLinux and macOS
would that result in a shortcode that is compatible with both Doxygen and Github?I considered that. Since both
#linuxmacOS
and#linux/macOS
(I didn't state this explicitly but#linux/macos
does not work) I think the issue is the upper case letters in macOS and not the /.
Okay... would Linux/Mac
or Linux and Mac
work?
Okay... would
Linux/Mac
orLinux and Mac
work?
Either would work, I ended up going with Linux and Mac
since that seems to better follow GitHub Markdown conventions (I could be wrong but I don't think the GitHub Markdown spec or the GitHub markdown formatting documentation explicitly address how section links handle non-alphabetic characters and uppercase alphabets).
I pushed some more changes: the CI needed to be tweaked a little once the CI containers started using the updated images from openquantumsafe/ci-containers#76. CI now uses scripts/run_doxygen.sh
(which does some formatting to make GitHub markdown work with Doxygen) instead of calling Doxygen directly. I'm not why the older way earlier but doesn't anymore; for what it's worth, the new way of using scripts/run_doxygen.sh
follows how ninja gen_docs
generates documentation.
Undoes changes from #1769 and re-introduces changes from #1715 to satisfy Doxygen release 1.10.0.
GitHub markdown provides a few extension in addition to the standard Markdown spec; a valid GitHub Markdown file isn't necessarily a valid Markdown file (see this comment by a Doxygen contributer). Changing
#linuxmacos
to either#linuxmacOS
or#linux/macOS
worked for me locally; I chose#linuxmacOS
because that seems to keep the link intact at the moment.CI containers currently use Doxygen 1.9.2, openquantumsafe/ci-containers#76 updates them to use Doxygen 1.10.0.