Skip to content

feat: link methods in javadocs to source code#1866

Merged
mcm001 merged 1 commit intoPhotonVision:mainfrom
samfreund:feat-link-to-source-code-docs
Apr 9, 2025
Merged

feat: link methods in javadocs to source code#1866
mcm001 merged 1 commit intoPhotonVision:mainfrom
samfreund:feat-link-to-source-code-docs

Conversation

@samfreund
Copy link
Member

@samfreund samfreund commented Apr 9, 2025

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:

  • Pull Request title is short, imperative summary of proposed changes
  • The description documents the what and why
  • If this PR changes behavior or adds a feature, user documentation is updated
  • If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly
  • If this PR touches configuration, this is backwards compatible with settings back to v2024.3.1
  • If this PR addresses a bug, a regression test for it is added

@samfreund samfreund requested a review from a team as a code owner April 9, 2025 18:18
@samfreund samfreund added documentation Anything relating to https://docs.photonvision.org enhancement New feature or request labels Apr 9, 2025
@mcm001
Copy link
Contributor

mcm001 commented Apr 9, 2025

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 mcm001 enabled auto-merge (squash) April 9, 2025 18:29
@samfreund
Copy link
Member Author

samfreund commented Apr 9, 2025

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?

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.

@samfreund samfreund mentioned this pull request Apr 9, 2025
@mcm001 mcm001 merged commit ea9bd4a into PhotonVision:main Apr 9, 2025
36 checks passed
@samfreund samfreund deleted the feat-link-to-source-code-docs branch April 9, 2025 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Anything relating to https://docs.photonvision.org enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link to source code from javadoc

2 participants