feat: link methods in javadocs to source code#1866
Merged
mcm001 merged 1 commit intoPhotonVision:mainfrom Apr 9, 2025
Merged
Conversation
Contributor
|
It'd be really really cool if we could preview what the javadocs will look like. Do you know if there's a good way to just host them on read the docs as static assets? |
mcm001
approved these changes
Apr 9, 2025
Member
Author
Not on RTD, but it looks like we might be able to publish a github pages preview. Edit: It looks like we can probably modify photon-code-docs to publish a preview to github pages when it's on a PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
When in javadocs, clicking on a method will open the source code for that method. This is currently implemented for the WPILib javadocs, and I'm just stealing it from there.
closes #1865
Meta
Merge checklist: