-
Notifications
You must be signed in to change notification settings - Fork 23
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
[docgen] generated docs should contain anchors for each section #117
Comments
Well, it actually does create anchors. If you try to go to e.g: https://nim-lang.github.io/Nim/contributing.html#stdlib it will show you the correct section. However it doesn't generate any way to get these anchors. It appears like there is some part of the documentation generation that inserts a toc. But I don't know what exactly adds it and how. |
@PMunch I added 2 EDIT's above to clarify |
This RFC is stale because it has been open for 1095 days with no activity. Contribute a fix or comment on the issue, or it will be closed in 7 days. |
This seems like an issue that doesn't require much discussion and with extremely low impact/risk so removing stale label. |
honestly I am not sure there even still is an issue and what would that be, I think it can be safely closed. If I look at https://nim-lang.github.io/Nim/algorithm.html and scroll down to the first appearance of Again in https://nim-lang.github.io/Nim/contributing.html#stdlib if I hover over stdlib I do see the url. I also see a TOC in https://nim-lang.github.io/Nim/contributing.html |
and in case there are still issues, it looks more than an issue for Nim than a RFC (maybe it was not at the time...) |
https://nim-lang.github.io/Nim/contributing.html (and probably other generated html pages) don't have any anchors; eg I can't easily point to a specific section of that html page in code reviews
that's a bit odd because other pages (eg https://nim-lang.github.io/Nim/lib.html) do show anchors for each section
EDIT https://nim-lang.github.io/Nim/contributing.html#stdlib works but hovering on
stdlib
section doesn't show a url (from which you can right-click/copy link), unlike what happens when hovering onCore
in https://nim-lang.github.io/Nim/lib.htmlEDIT no TOC is created for https://nim-lang.github.io/Nim/contributing.html
symbols (procs etc) in docs (eg: https://nim-lang.github.io/Nim/algorithm.html) don't show anchors (eg for sorted, no anchor shown near proc definition) even though we can navigate to such section via https://nim-lang.github.io/Nim/algorithm.html#sorted%2CopenArray%5BT%5D%2Cproc%28T%2CT%29 ; it's just a matter of showing the anchor in generated docs
The text was updated successfully, but these errors were encountered: