Set up Sphinx Documentation Workflow

SJSURoboticsTeam / urc-intelligent-systems-2023

Intelligent Rover Systems for University Rover Challenge. Involves Computer Vision & Algorithm Pathing for autonomous exploration.

6 stars 4 forks source link

Set up Sphinx Documentation Workflow #109

Closed RK22000 closed 6 months ago

RK22000 commented 7 months ago

We've set up a sphinx documentation site. Now we need to start using it. Use this issue to discuss steps on this front. Some things that need to be done.

The site build locally does not perfectly match with the site built and deployed by github. For instance on the local build all the python doc string are shown in the doc site. However the github build site only shows the function signatures

RK22000 commented 6 months ago

Hey this has been resolved for a while now. Specifying the python version to use with sphinx resolved this issue.