Skip to content
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.

Sign up for GitHub

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

Jump to bottom

generated docs: source listings with links back to docs #3403

Closed
andrewrk opened this issue Oct 8, 2019 · 2 comments · Fixed by #19208
Closed

generated docs: source listings with links back to docs #3403

andrewrk opened this issue Oct 8, 2019 · 2 comments · Fixed by #19208
Labels
autodoc The web application for interactive documentation and generation of its assets. enhancement Solving this issue will likely involve adding new logic or components to the codebase.
Milestone
0.12.0

Comments

@andrewrk
Copy link
Member

andrewrk commented Oct 8, 2019

Extracted from #21

The idea here is you can easily get to the source for a given function, decl, or type, and while looking at the source, get back to the docs. Functions would list callsites so that you could look at an example or at least a test of how something is used.
@andrewrk andrewrk added docs stage1 The process of building from source via WebAssembly and the C backend. labels Oct 8, 2019
@andrewrk andrewrk added this to the 0.6.0 milestone Oct 8, 2019
@andrewrk andrewrk mentioned this issue Oct 8, 2019
Closed
@andrewrk andrewrk mentioned this issue Oct 19, 2019
Merged
@andrewrk andrewrk modified the milestones: 0.6.0, 0.7.0 Feb 18, 2020
@andrewrk andrewrk mentioned this issue Oct 4, 2020
Closed
@andrewrk andrewrk modified the milestones: 0.7.0, 0.8.0 Oct 17, 2020
@andrewrk andrewrk modified the milestones: 0.8.0, 0.9.0 Nov 6, 2020
@andrewrk andrewrk modified the milestones: 0.9.0, 0.10.0 May 19, 2021
@Vexu
Copy link
Member

Vexu commented Dec 7, 2022

Added to Autodoc in #12374

@Vexu Vexu closed this as completed Dec 7, 2022
@Vexu Vexu removed this from the 0.12.0 milestone Dec 7, 2022
@andrewrk andrewrk reopened this Dec 7, 2022
@andrewrk
Copy link
Member Author

andrewrk commented Dec 7, 2022

links back to docs have not been implemented

@Vexu Vexu added autodoc The web application for interactive documentation and generation of its assets. and removed stage1 The process of building from source via WebAssembly and the C backend. docs labels Dec 7, 2022
@Vexu Vexu modified the milestone: 0.11.0 Dec 8, 2022
@andrewrk andrewrk modified the milestones: 0.11.0, 0.12.0 Apr 9, 2023
@andrewrk andrewrk modified the milestones: 0.13.0, 0.12.0 Jul 22, 2023
@andrewrk andrewrk mentioned this issue Jul 22, 2023
Closed
@andrewrk andrewrk added the enhancement Solving this issue will likely involve adding new logic or components to the codebase. label Jul 22, 2023
@andrewrk andrewrk mentioned this issue Mar 7, 2024
Merged
@andrewrk andrewrk modified the milestones: 0.13.0, 0.12.0 Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
autodoc The web application for interactive documentation and generation of its assets. enhancement Solving this issue will likely involve adding new logic or components to the codebase.
Projects
None yet
Milestone
0.12.0
Development

Successfully merging a pull request may close this issue.

Redesign How Autodoc Works ziglang/zig
2 participants
@andrewrk @Vexu