search

flexivrobotics / flexiv_rdk

RDK (robotic development kit) for Flexiv robots. Supports C++ and Python. Compatible with Linux, macOS, and Windows.
Apache License 2.0
58 stars 18 forks source link

Where can I find API doc for different version #51

Closed Valen-C12 closed 3 months ago

Valen-C12 commented 3 months ago

The api doc is for version 0.9, but there is other newer version like 1.3, 1.4-dev in the releases, where can i find the docs for them? BTW, what is the difference of pre-release, can i use such versions? when will them be released? after all the released is 0.9 before almost 4 monthes, but the pre-release is already 1.4-dev :)

pzhu-flexiv commented 3 months ago

@Valen-C12 Hi, the API doc is auto-generated by Doxygen, you can easily generate the API doc for any version by running:

sudo apt install doxygen-latex graphviz
cd flexiv_rdk
doxygen doc/Doxyfile.in

Then under flexiv_rdk/doc/html, you'll find the generated API doc. Open any .html file with your browser then you'll see the doc.

Valen-C12 commented 3 months ago

@pzhu-flexiv Got it, thank you for the quick response!