cudf icon indicating copy to clipboard operation
cudf copied to clipboard

Publish C++ developer docs

Open vyasr opened this issue 2 years ago • 0 comments

Description

This PR adds the developer documentation to our doxygen. The changes are minimal: the files have been moved from cpp/docs to cpp/doxygen and added to the INPUT section of the Doxyfile, and a custom DoxygenLayout.xml has been added to include the necessary header (note that this file was autogenerated with doxygen -l and the only modification was adding one tab for the developer guide). I added an anchor to the main developer guide header so that it can be linked to from the header.

This PR is currently a draft because our developer documentation does not all render well yet inside doxygen. The issues that I notice so far:

  1. Code font does not render in headers, so all the headers that are classes or functions need backticks removed.
  2. All @ symbols will by default be interpreted by doxygen, so examples of documentation inside our doxygen need to have those escaped.
  3. The doxygen pre-commit check will also interpret parts of these files, so we essentially need to make sure that all doxygen there is valid. Fixing this is honestly probably worthwhile anyway.

Assuming nobody views changing these as dealbreakers, I think we can safely move forward here and I can make the necessary changes. This is how it looks now:

image

Checklist

  • [x] I am familiar with the Contributing Guidelines.
  • [x] New or existing tests cover these changes.
  • [x] The documentation is up to date with these changes.

vyasr avatar Aug 04 '22 23:08 vyasr

Codecov Report

:exclamation: No coverage uploaded for pull request base (branch-22.10@ecf4662). Click here to learn what that means. Patch has no changes to coverable lines.

Additional details and impacted files
@@               Coverage Diff               @@
##             branch-22.10   #11475   +/-   ##
===============================================
  Coverage                ?   86.42%           
===============================================
  Files                   ?      145           
  Lines                   ?    23009           
  Branches                ?        0           
===============================================
  Hits                    ?    19885           
  Misses                  ?     3124           
  Partials                ?        0           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Aug 29 '22 23:08 codecov[bot]

@gpucibot merge

vyasr avatar Sep 12 '22 19:09 vyasr

rerun tests

vyasr avatar Sep 12 '22 20:09 vyasr