Skip to content

Support comments when generating documentation #1

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Vrixyz
Copy link
Contributor

@Vrixyz Vrixyz commented Oct 9, 2024

This PR also adds support to target documentation on a local path. It copies the whole directory and parses that. But it has a few limitations:

  • I imagine we could parse directly the provided path, but I went the "easy way"
  • some links are hardcoded to crates.io, so we'd need to improve that to target local dependencies (maybe compile said crate locally too? and/or provide hybrid solution?)

I added a small diagram I did to understand the architecture, let me know if it's welcome or should I remove it.

Comment on lines +24 to 25
root_crate_location: &CrateLocation,
root_crate_version: &Version,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Version is a bit useless when targeting local, but we'd have to rework the dropdown choice to support local.

@jannik4
Copy link
Owner

jannik4 commented Dec 30, 2024

Hey, I would like to update to support bevy 0.15. Since you already did this here, would you like to split this PR and we can merge the changes for 0.15? If not, I would just make a separate PR and you would have to rebase when the upstream changes are ready.

@Vrixyz Vrixyz mentioned this pull request Dec 30, 2024
@Vrixyz
Copy link
Contributor Author

Vrixyz commented Dec 30, 2024

I believe my work on this was before the whole naga update in bevy, but I'll open a split PR to get a discussion started at #2 :)

jannik4 added a commit to jannik4/wesldoc that referenced this pull request Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants