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

docgen for threads and builtin_channels links broken #1466

Open
saem opened this issue Oct 24, 2024 · 0 comments
Open

docgen for threads and builtin_channels links broken #1466

saem opened this issue Oct 24, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Easy-to-start-with issue with no in-depth knowledge or complex implementation required. help wanted Extra attention is needed

Comments

@saem
Copy link
Collaborator

saem commented Oct 24, 2024

Threading and channels related documentation is now generated again, as part of #1464, but due to a docgen bug the documentation for the threads and builtin_channels modules, which are included from the system module do not work.

This used to work with the legacy docgen feature, but that has since been removed, see: #303. Update the existing docgen to get the links working again from the generated index.html.
@saem saem added bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Easy-to-start-with issue with no in-depth knowledge or complex implementation required. labels Oct 24, 2024
@saem saem changed the title protip: write the body first, then summarize into a title docgen for threads and builtin_channels links broken Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Easy-to-start-with issue with no in-depth knowledge or complex implementation required. help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@saem