toppra
toppra copied to clipboard
Build cpp doc on readthedocs with sphinx
TODOs:
- [ ] Create a simple example for the C++ API online.
This will take you a lot of effort for not so much. readthedocs does not provide Doxygen support and getting sphinx to generate your C++ documentation is not gonna be easy.
At the moment, getting the documentation is done by:
- cloning the repo (but if you are looking at the API, this is not a big problem) and
- running
make doc
(this means you have to run cmake).
Is this method a problem ?
This is to serve both the Python and C++ API in the same place. https://toppra.readthedocs.io/en/latest/
I have done something similar before using sphinx via breath (https://breathe.readthedocs.io/en/latest/directives.html). As long as the readthedocs server can run 'doxygen', there should be no problem.
Stale issue message
@jmirabel I am thinking that the doxygen docs build can be uploaded to the same place as the sphinx docs at https://hungpham2511.github.io/toppra/
What do you think?
It would be a nice indeed.
Stale issue message