PhotonVision / photonvision

PhotonVision is the free, fast, and easy-to-use computer vision solution for the FIRST Robotics Competition.
https://photonvision.org
GNU General Public License v3.0
278 stars 201 forks source link

Add a stable version of the PhotonVision Read the Docs. It currently only has the latest dev version. #1491

Open VStellar2023 opened 1 month ago

VStellar2023 commented 1 month ago

Is your feature request related to a problem? Please describe.

The code in the "Aiming at a Target" example java code has a method called getAllUnreadResults(), which does not exist in the PhotonLib library that was provided on the PhotonLib > Installing PhotonLib section of the docs. I believe this is because the PhotonVision Read the docs only have a latest development version published (which I think is not fully updated/debugged?); they do not have a stable version published.

Describe the solution you'd like

A stable version of the PhotonVision Read the Docs should be published.

Describe alternatives you've considered

N/A - I fixed this problem by just grabbing the PhotonLib zip file from the latest development version in GitHub, which included this method. After that the issue was solved.

Additional context

It was giving me the error: " the method getAllUnreadResults() is undefined for the type PhotonCamera."

mcm001 commented 1 month ago

Looks easy to do from the read the docs side https://docs.readthedocs.io/en/stable/versions.html

mcm001 commented 3 weeks ago

docs.photonvision.org now defaults to https://docs.photonvision.org/en/v2025.0.0-alpha-0/ and has an option for latest if you want it. this is 90% of the way there, api docs are still unversioned.

mcm001 commented 3 weeks ago

API docs covered by #1378