search

TACC / Galaxy

Galaxy is an asynchronous parallel visualization ray tracer for performant rendering in distributed computing environments. Galaxy builds upon Intel OSPRay and Intel Embree, including ray queueing and sending logic inspired by TACC GraviT.
Apache License 2.0
19 stars 9 forks source link

Doxygen document generation fails when running from doc folder #4

Closed kks32 closed 5 years ago

kks32 commented 5 years ago

This may not be the right way to create the documentation, but when I tried running doxygen from the doc folder, instead of inside docs/doxygen folder due to relative paths specified in Doxyfile it doesn't generate the documentation correctly. A possible solution maybe to move Doxyfile to root directory and remove the relative paths

Running doxygen from docs/doxygen folder works fine and generates all the documentation.

kks32 commented 5 years ago

Would like to add if we have https://github.com/TACC/Galaxy/blob/master/doc/doxygen/Doxyfile#L1118 to HTML_OUTPUT = ./docs in Doxyfile it will generate the documents in the root folder under docs/ folder. The reason this is preferable is GitHub has an option to serve these as GitHub pages for documentation as long as there is a folder called docs in the root directory https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages. Thought I would share, if you would like to go in that direction! Thanks!