[WIP] Docs using Sphinx and Doxygen#266
[WIP] Docs using Sphinx and Doxygen#266akhiltulluri wants to merge 4 commits into1a1a11a:developfrom
Conversation
|
@1a1a11a - do I migrate everything under Also with doxygen, what are the things that need to be in docs? I think with breathe we've to selectively choose what parts of the docs from code must be shown in sphinx and where. |
|
Thank you! Looks good overall. Let's use |
|
You can make the decision on what to include in the doc website. @haochengxia and I will help you iterate on this. |
|
@haochengxia do you think we should have a separate doc for the Python binding or mix with the main doc? |
|
We could separate them to avoid overwhelming beginners who want to try out Python packages first. |
This is still WIP but provides a baseline setup for publishing docs with Sphinx, doxygen, breathe and readthedocs. Related to #127
Preview sample doc generated: https://libcachesimtest.readthedocs.io/en/latest/