Add [src] links to function decls in autodocs #13120
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related issue: #12759
Hi! I was looking for a way to familiarize myself a bit more with Zig, and having previously poked with autodoc a bit a month or two ago, I figured I'd grab this quick one-liner to carry forward
[src]links on function declaration docs pages.Here's the result:
Which links to this page:
I do have a couple questions concerning development on autodoc in general not specific to this PR, and happy to move these to issues/discussions if this isn't the appropriate spot for questions:
I'm struggling a bit to understand the development flow of
index.htmlandmain.js. From my reading of the docs, I should be able to edit either of these files, runzig build-obj -femit-docs <file>.zig, and it should copylib/docs/{index.html,main.js}to the newly createddocs/folder. However, when I make edits to either of the two files then run that, it does not take my edits (it uses whatever is in themasterbranch). I read the code and ran a quick strace, and I see that it's just doing a copy to a temporary file and renaming. I'm not sure why my edits aren't being applied to those files? Any advice there?I see that there's a section in the docs about writing type-annoted javascript, but it looks like that was recently removed. Should that section of the docs be deleted?
Thanks!