-
Notifications
You must be signed in to change notification settings - Fork 476
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change README links to be doxygen-friendly #1927
Conversation
Signed-off-by: Douglas Stebila <[email protected]>
64e2b6f
to
35f819d
Compare
It seems that Doxygen has strong opinions about upper/lowercase on anchors generated from Markdown, and these opinions differ from Github's choices. In my tests the links still scroll to the right anchors in the cross-referenced page, but someone else please confirm. It would be annoying to break cross-references in one program to make them work in another program, and vice versa. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm inclined to say: while this PR is not perfect, it unbreaks building of docs. Thus, let us merge it, and add improvements later. Rather than argue about the best way, while gen_docs
remains broken/unusable.
Do we want to merge this now for inclusion in 0.11.0? I can't think of a risk that would merit a new release candidate, but want to check if anyone has another opinion. |
I can't imagine any risk in including this, and it would be nice to have working release docs on macOS. |
I will go ahead and hit merge, as there seems to be consensus (based on approvals/thumbs-ups) that (1) this is desirable for the release and (2) it's not necessary to cut a new RC. |
Thanks Spencer! |
Fixes #1897.