Skip to content

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

Conversation

Krishna-13-cyber
Copy link
Contributor

Signed-off-by: [email protected] Krishna Narayanan

CMakeLists.txt Outdated
Comment on lines 349 to 351
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")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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")

@vgvassilev
Copy link
Contributor

@Krishna-13-cyber ping.

@Krishna-13-cyber Krishna-13-cyber force-pushed the CppInterOp-Doxygen-Implementation branch from 77f76c0 to 6350741 Compare June 18, 2023 18:14
@Krishna-13-cyber Krishna-13-cyber force-pushed the CppInterOp-Doxygen-Implementation branch from 6350741 to 5f8c574 Compare June 18, 2023 18:22
@Krishna-13-cyber Krishna-13-cyber changed the title Add initial setup for doxygen documentation Add setup for doxygen documentation Jun 18, 2023
@vgvassilev vgvassilev added this pull request to the merge queue Jun 20, 2023
Merged via the queue into compiler-research:main with commit 7dda67c Jun 20, 2023

INTEROP_ROOT = '..'

# html_extra_path = [INTEROP_ROOT + '/build/docs/doxygen/html']

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.

Copy link
Contributor Author

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/

Copy link

@parth-07 parth-07 Jun 24, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants