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.

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

docs: build documentation for threading-related modules #1464

Merged
merged 2 commits into from
Oct 24, 2024

Conversation

Luyten-Orion
Copy link
Contributor

@Luyten-Orion Luyten-Orion commented Oct 7, 2024

Summary

kochdocs.nim in tools/koch/kochdocs.nim , docDefines now has
--threads:on to build docs for relevant threading API.

@zerbina zerbina added the documentation Improvements or additions to documentation label Oct 7, 2024
@zerbina zerbina changed the title Add --threads:on to kochdocs. docs: build documentation for threading-related modules Oct 7, 2024
@zerbina
Copy link
Collaborator

zerbina commented Oct 7, 2024

Thank you for the PR! I've changed the title to make it a bit clearer what the user-relevant impact is.

@zerbina
Copy link
Collaborator

zerbina commented Oct 19, 2024

@Luyten-Orion: The compiler bug causing the koch doc failure should now be fixed (sorry that it took so long). Could you merge the devel branch into your PR?

@Luyten-Orion
Copy link
Contributor Author

Sorry it took me so long, it's been done now

Copy link
Collaborator

@zerbina zerbina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the threading-related API now shows up in the index, but the links in index.html are still broken, as both the threads and channel_builtin modules are included from system.nim, meaning that they need to be special-cased by doc generation. They once were, but this changed in #303.

In my opinion, this can be addressed separately, and I think the PR is good to go.

@saem
Copy link
Collaborator

saem commented Oct 24, 2024

/merge

I created an issue for the fix for the links themselves.

Copy link

Merge requested by: @saem

Contents after the first section break of the PR description has been removed and preserved below:


@chore-runner chore-runner bot added this pull request to the merge queue Oct 24, 2024
Merged via the queue into nim-works:devel with commit fb4665a Oct 24, 2024
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants