Doxygen

[jaelynlitz]

No description provided.

[ryandanehy]

Documentation lives here https://ornl.github.io/ReSolve/

To see the doxygen based documentation check out the source documentation page.

These docs will be built on every pr automatically so that contributors can see their additions.

Options to futher explore:
Direct links to certain doxygen pages on the main read the docs page.
More page and content to add.

PS: This is made via github action I created here: https://github.com/ryandanehy/sphinx-doxygen Therefore it should be incredibly easy to apply this method of documentation to other repos.

[ryandanehy]

@pelesh

[pelesh]

@ryandanehy, this is great! A couple of suggestions:

• Provide links to readthedocs at main README file.
• Similarly to doxygen API docs.
• For some reason, doxygen docs are not built with doxygen awesome stylesheets. Could we fix that.

Other than these minor issues, this looks very good.

[pelesh]

Also, to add to the list above, Doxygen needs to be built with graphviz support, so it can draw UML diagrams.

[pelesh]

@ryandanehy, it seems that as we are providing Doxygen input file template, we are overriding Doxygen options set in CMake. I'll take a look. Ideally, all of our preferred options should be in the input file template. That will make CMake config cleaner, as well.

[ryandanehy]

@pelesh I think I made the changes you requested. Lmk what you think.
Documentation lives here https://ornl.github.io/ReSolve/

[pelesh]

There are some minor changes to make, most importantly Doxygen options selected in the CMake file should be placed in the Doxyfile.in as my understanding is it is used to generate Doxygen docs (at least based on conf.py file.

Also, in the Doxygen docs, UML files are not generated or at least I don't see them.

[ryandanehy]

@pelesh is this what you were going for?
https://ornl.github.io/ReSolve/doxygen/html/dir_5136c54ba47d989d05eb394194374e6c.html

[cameronrutherford]

@pelesh is this what you were going for?

https://ornl.github.io/ReSolve/doxygen/html/dir_5136c54ba47d989d05eb394194374e6c.html

Looks much better!!

[pelesh]

@ryandanehy, let me please review once more. There are a few things such as copyright statement that needs to be fixed, but all the main features are in the PR and working. Thanks for the great work and figuring out all pathing nightmares ;).

[pelesh]

This is a good first attempt at getting documentation for ReSolve. There are several minor issues that are best addressed through separate PR(s).