geodynamics / Rayleigh

Rayleigh: Pseudo-spectral MHD
GNU General Public License v3.0
59 stars 49 forks source link

Add documentation to the cmake build system #558

Closed gassmoeller closed 1 month ago

gassmoeller commented 1 month ago

This adds the targets make doc, make doc_html, and make_pdf to the cmake build system. make doc builds both of the other targets.

The targets depend on all files in doc/source so it is only rebuild if something changes in that directory.

The only change to the existing system that I had to make was the modification to the conf.py that makes the exclude path of doc/build independent of the directory it is executed from (otherwise I got the same recursive addition of build files we repaired earlier in the week).