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

Publish API docs #1094

Merged
merged 12 commits into from
Jan 5, 2024
Merged

Publish API docs #1094

merged 12 commits into from
Jan 5, 2024

Conversation

mcm001
Copy link
Contributor

@mcm001 mcm001 commented Dec 30, 2023

Redirects I want:

demo.photonvision.org redirected to https://photonvision.github.io/photonvision/built-client/
javadocs.photonvision.org redirected to https://photonvision.github.io/photonvision/built-docs/javadoc/
cppdocs.photonvision.org redirected to https://photonvision.github.io/photonvision/built-docs/doxygen/html/

For now this runs on all commits to master. Once we confirm it works, let's pull back to only tagged releases

@mcm001 mcm001 changed the title 2023 12 30 javadoc pub Publish API docs Dec 30, 2023
@mcm001 mcm001 force-pushed the 2023-12-30_javadoc_pub branch 2 times, most recently from 2bd463a to acf70bb Compare January 3, 2024 20:18
Maybe also publish

Update documentation.yml

Update documentation.yml

Update documentation.yml

Update documentation.yml
@mcm001 mcm001 marked this pull request as ready for review January 3, 2024 21:59
@mcm001 mcm001 requested a review from a team as a code owner January 3, 2024 21:59
@gerth2
Copy link
Contributor

gerth2 commented Jan 5, 2024

Looks solid overall, though not sure exacatly how to test.

I ran gradlew docs:generateJavaDocs docs:doxygen in the root of the repo, but it errored with the following:


D:\Projects\photonvision\photon-core\src\main\java\org\photonvision\vision\pipe\impl\ArucoDetectionPipeParams.java:36: error: bad use of '>'
     * <p>E.g. 36h11 -> 11 * errorCorrectionRate = Max error bits
     

Hmmmm... expected?

@mcm001
Copy link
Contributor Author

mcm001 commented Jan 5, 2024

That's a new error. I'll have to fix it before we merge lol

Copy link
Contributor

@gerth2 gerth2 left a comment

Choose a reason for hiding this comment

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

Generates good-looking content locally for me. Concur, publish will be the next step

@mcm001 mcm001 merged commit b033f7e into PhotonVision:master Jan 5, 2024
23 checks passed
@mcm001 mcm001 deleted the 2023-12-30_javadoc_pub branch January 5, 2024 19:14
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.

3 participants