rocPRIM icon indicating copy to clipboard operation
rocPRIM copied to clipboard

Sphinx doc

Open v01dXYZ opened this issue 2 years ago • 3 comments

This MR proposes an alternative to the current documentation with another one that uses Sphinx and breathe.

Currently breathe needs a patch to fully support all the function signatures as arguments to the directives. I am waiting for the status of my suggested patch to breathe to get merged.

There could be some typos and a need to improve style and readability.

Edit: @Maetveis found a workaround to breathe deficiencies by using doxygengroup (although it does not generate signature with function names starting with ``rocprim::`).

v01dXYZ avatar Jun 14 '22 23:06 v01dXYZ

Let's get this building on readthedocs. We can enable builds for PRs.

saadrahim avatar Jun 14 '22 23:06 saadrahim

This MR proposes an alternative to the current documentation with another one that uses Sphinx and breathe.

Currently breathe needs a patch to fully support all the function signatures as arguments to the directives. I am waiting for the status of my suggested patch to breathe to get merged.

There could be some typos and a need to improve style and readability.

Thank you for the contribution. The rocPRIM team will look into this PR.

saadrahim avatar Jun 15 '22 00:06 saadrahim

For consistency, I will raise a PR against this to bring some changes to standardize our sphinx/breathe invocation to the other libraries in our team.

saadrahim avatar Jun 21 '22 16:06 saadrahim

@Maetveis @stanleytsang-amd Can this PR be prioritized?

saadrahim avatar Nov 10 '22 19:11 saadrahim

closing in favor of #418

saadrahim avatar Mar 31 '23 01:03 saadrahim