toppra icon indicating copy to clipboard operation
toppra copied to clipboard

Build cpp doc on readthedocs with sphinx

Open hungpham2511 opened this issue 4 years ago • 6 comments

TODOs:

  • [ ] Create a simple example for the C++ API online.

hungpham2511 avatar Apr 25 '20 03:04 hungpham2511

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 ?

jmirabel avatar Apr 25 '20 13:04 jmirabel

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.

hungpham2511 avatar Apr 25 '20 13:04 hungpham2511

Stale issue message

github-actions[bot] avatar Jul 07 '20 00:07 github-actions[bot]

@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?

hungpham2511 avatar Oct 29 '20 00:10 hungpham2511

It would be a nice indeed.

jmirabel avatar Oct 29 '20 06:10 jmirabel

Stale issue message

github-actions[bot] avatar Oct 30 '21 00:10 github-actions[bot]