Open-Agriculture / AgIsoStack-plus-plus

AgIsoStack++ is the completely free open-source C++ ISOBUS library for everyone
https://agisostack.com/
MIT License
168 stars 40 forks source link

Bootstrap public api documentation in sphinx #401

Closed GwnDaan closed 6 months ago

GwnDaan commented 6 months ago

To enhance the user experience for finding the right parts of the public api of the stack, I think adding them to the sphinx site is a good idea. Note that this doesn't replace the doxygen documentation, instead it provides a more structured alternative for less experienced users.

It is automatically build as well: https://agisostack-plus-plus.readthedocs.io/en/latest/api/index.html.

Also I claimed the agisostack-plus-plus subdomain, so we probably want the isobus-plus-plus subdomain to redirect to it?

sonarcloud[bot] commented 6 months ago

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

ad3154 commented 6 months ago

It seems like redirecting the whole thing is not really supported without some hacky workarounds... I wonder if we merge it if it'll build identical docs for both RTD projects?

GwnDaan commented 6 months ago

I wonder if we merge it if it'll build identical docs for both RTD projects?

Hmm, yeah that could work I think. Though I feel like that stresses RTD servers for no good reason, so maybe the hacky way is fine hahah?

I found this stackoverflow post which we can follow instead; https://github.com/GwnDaan/AgIsoStackpp-docs-redirect. I setup a test redirect https://agisostackplusplus.readthedocs.io and it seems to work fine