h5cpp icon indicating copy to clipboard operation
h5cpp copied to clipboard

docs do not build

Open drsramd opened this issue 4 years ago • 2 comments

cmake 22.3 gcc 9.3 linux 20.04 all deps satisfied

cmake does not build /doc

drsramd avatar Jan 07 '22 15:01 drsramd

Building docs is tricky because in order to do it we usually need to install newer versions of breathe and sphinx that in the distribution. They contain necessary bug fixes. Currently, we use ubuntu 20.04 to build the docs, i.e. https://jenkins.esss.dk/dm/blue/organizations/jenkins/ess-dmsc%2Fh5cpp/detail/master/348/pipeline/570 which gives us https://ess-dmsc.github.io/h5cpp/latest/index.html but we install breathe and sphinx with pip https://github.com/ess-dmsc/h5cpp/blob/955903b741c9b7e7608a9b1ea4f9ef31d81f8f21/Jenkinsfile#L188 On debian11 make html works with packages given it the distribution.

Could you show us the error you get when you build the documentation then we can help you more.

jkotan avatar Jan 07 '22 20:01 jkotan

Thank you very much; in my setup it had to be installed system wide as root, sudo make html had to be used output ended up in builld/Release/doc/build, system wide installation is still obsure to me ...

drsramd avatar Jan 08 '22 15:01 drsramd