-
Notifications
You must be signed in to change notification settings - Fork 30
Add setup for doxygen documentation #87
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add setup for doxygen documentation #87
Conversation
CMakeLists.txt
Outdated
option(INTEROP_INCLUDE_DOCS "Generate build targets for the Cppinterop docs.") | ||
option(INTEROP_ENABLE_DOXYGEN "Use doxygen to generate Cppinterop interal API documentation.") | ||
option(INTEROP_ENABLE_SPHINX "Use sphinx to generage Cppinterop user documentation") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
option(INTEROP_INCLUDE_DOCS "Generate build targets for the Cppinterop docs.") | |
option(INTEROP_ENABLE_DOXYGEN "Use doxygen to generate Cppinterop interal API documentation.") | |
option(INTEROP_ENABLE_SPHINX "Use sphinx to generage Cppinterop user documentation") | |
option(INTEROP_INCLUDE_DOCS "Generate build targets for the CppInterOp docs.") | |
option(INTEROP_ENABLE_DOXYGEN "Use doxygen to generate CppInterOp interal API documentation.") | |
option(INTEROP_ENABLE_SPHINX "Use sphinx to generage CppInterOp user documentation") |
@Krishna-13-cyber ping. |
77f76c0
to
6350741
Compare
Signed-off-by: <[email protected]> Krishna Narayanan
6350741
to
5f8c574
Compare
|
||
INTEROP_ROOT = '..' | ||
|
||
# html_extra_path = [INTEROP_ROOT + '/build/docs/doxygen/html'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this commented out?
And also, html_extra_path
directory probably should not contain index.html
file. Otherwise,
readthedocs will get confused which page should be used when visiting the website root.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my next patch to fix the issue of doxygen, I have added the html_extra_path
main...Krishna-13-cyber:CppInterOp:CppInterOp-Doxygen-Implementation#diff-85933aa74a2d66c3e4dcdf7a9ad8397f5a7971080d34ef1108296a7c6b69e7e3R54 but still the issue persists .
The index.html for sphinx is being used as website root as we can see the output. The build directory of doxygen which consists of index.html is implicitly generated by default, so are you suggesting to modify the config to remove the index generation?
Current Status including the html_extra_path
:
https://readthedocs.org/projects/cppinterop-docs/builds/21074694/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am suggesting to make the html_extra_path
to something like, INTEROP_ROOT + '/build/docs'
. This way we can
access internal documentation at ${WebsiteRoot}/doxygen/html
, and index.html
of sphinx and doxygen will not conflict with each other.
Signed-off-by: [email protected] Krishna Narayanan