Fix build issues with documentation#7122
Conversation
Doxygen cannot generate docs for `operator+` or `operator-`
| Below, ``segmented_sort`` is used to perform a segmented sort. It also rearranges the values according to the keys' order. | ||
|
|
||
| .. literalinclude:: ../../python/cuda_cccl/tests/parallel/examples/sort/segmented_sort_basic.py | ||
| .. literalinclude:: ../../python/cuda_cccl/tests/compute/examples/sort/segmented_sort_basic.py |
There was a problem hiding this comment.
This is giving a warning about missing :end-after:
The same for radix_sort, maybe because there are 2 examples after each other? @shwina
This comment has been minimized.
This comment has been minimized.
| #if !_CCCL_COMPILER(NVRTC) && !defined(_CCCL_DOXYGEN_INVOKED) | ||
| inline ::std::ostream& operator<<(::std::ostream& os, RadixSortStoreAlgorithm algo) |
There was a problem hiding this comment.
Question: I don't understand why Doxygen cannot handle operator<<. I think it should be publicly documented it would be sad to see it go. What's the problem here?
There was a problem hiding this comment.
I dont know either, from the error message I guess it is that it tries to putt the << into the section header and that does things
There was a problem hiding this comment.
Super annoying! I hope we can bring the docs back at some point.
This comment has been minimized.
This comment has been minimized.
🥳 CI Workflow Results🟩 Finished in 3d 05h: Pass: 100%/190 | Total: 6d 11h | Max: 5h 28m | Hits: 71%/264166See results here. |
shwina
left a comment
shwina
left a comment
There was a problem hiding this comment.
Approving Python changes - thank you for catching this!
3 participants
Our docs currently do not build.
I tried to address as many probloms as possible, however there are still some strange errors complains about a missing :end-after: string, but only sometimes 🤷
Also for whatever reason doxygen sometimes does not find the right module label of the any_resource files?