Add documentation generation

Open karthikeyann opened this issue 3 years ago • 0 comments

move doxygen config file and other generated and additional files from nvlabs/cub/gh-pages to main docs/ directory
add cmake rule, make docs generates documentation in docs/html
update config, templates to doxygen 1.8.4

Steps to build docs:

Update PROJECT_NUMBER to new cub release version in docs/Doxyfile (checkout this release)
mkdir build; cd build; cmake -DCUB_ENABLE_DOXYGEN=ON -DCUB_ENABLE_HEADER_TESTING=OFF -DCUB_ENABLE_TESTING=OFF -DCUB_ENABLE_EXAMPLES=OFF .. && make cub.docs build/docs/html/ will have the generated documentation.

Updating to latest doxygen version would require css changes which would take more time. Also, working on a change https://github.com/doxygen/doxygen/pull/9318 in doxygen to update newline and indentation for long class template parameters. (TODO in next PR)

May 09 '22 15:05 karthikeyann