Trying to build the docs - where are the files?

Q&A
1

First time trying to build the docs on macOS following Contributing Documentation guidlines. I got it to build (lots of warm air) but I’m stumped where to find the resulting html documentation?

2

You need to do a make install otherwise they live spread inside the build dir (like the rest of binaries.

3

That did the trick. Not seeing the forest for the trees … Thank you @Joaquim!

4

Where does make install place the files?

My routine is to do a $ cmake --build . --target docs_html.
The docs will then be placed in $builddir/doc/rst/html/, and I can access e.g. $builddir/doc/rst/html/index.html to get to the same landing page as the online docs.

5

Hi @Andreas, I configured GMT_DOCDIR in the file ConfigUserAdvanced.cmake to my liking so I can place them wherever I want (as long as I have write access).

1 Like
6

Nice tips. Thanks!