stotko / stdgpu

stdgpu: Efficient STL-like Data Structures on the GPU
https://stotko.github.io/stdgpu/
Apache License 2.0
1.16k stars 83 forks source link

cmake: Add option to enable building the documentation #368

Closed stotko closed 1 year ago

stotko commented 1 year ago

Documentation building is optional and excluded by default, so the actual build must be explicitly run via a respective CMake target. However, the corresponding CMake code is always parsed which includes downloading the modern doxygen theme and setting up all targets. Add a CMake option STDGPU_BUILD_DOCUMENTATION to allow for completely disabling all of these steps. Furthermore, since users typically do not attempt building the documentation, set its default value to OFF.

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (203298a) 97.29% compared to head (58e7b6c) 97.29%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #368 +/- ## ======================================= Coverage 97.29% 97.29% ======================================= Files 31 31 Lines 2480 2480 ======================================= Hits 2413 2413 Misses 67 67 ```

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