netcdf-c icon indicating copy to clipboard operation
netcdf-c copied to clipboard

Documentation partially built, not installing

Open gus-correa opened this issue 2 years ago • 1 comments

Dear netCDF pros

I am trying to build the full documentation of netcdf C, version 4.9.0, on Ubuntu 22.04. Only part of the documentation is built. In addition, "make install", only installs a small number of man pages under the "share" directory, which would be installed without doxygen anyway (see below). I was expecting the html, pdf, tex, documentation, and the man pages for the nc_* functions to be installed under "share" also, but they aren't. Other than this, netCDF C builds fine. I already built the netCDF Fortran and C++, but would be nice to have the documentation installed.

Questions: Is there a way to build the whole documentation and install it under "share"? What am I missing here? Please advise.

Final state of the "share" directory after running "make install":

share └── man ├── man1 │   ├── nccopy.1 │   ├── ncdump.1 │   ├── ncgen.1 │   └── ncgen3.1 └── man3 └── netcdf.3

Additional information:

I installed the doxygen, dot2latex, graphviz packages along with the corresponding "dev" packages. I configured with these additional options (which presumably enable documentation to be built):

--enable-doxygen \
--enable-dot \
--enable-doxygen-pdf-output \

The configure script recognizes doxygen and doc. The make step populates the docs subdirectory on my build dir with these subdirectories:

docs ├── html │   └── search ├── images ├── latex_main └── man └── man3

The html directory seems to be populated, and pointing the browser to index.html I can navigate across the html documentation. However, it is not installed by "make install".

The latex_main directory has a bunch of .md5, .tex, and .pdf files, but not all .tex generates a .pdf. I displayed a few .pdf, and they seem to be mostly source code dependency graphs.
"make install" doesn't install them under "share" either.

The man/man3 directory has many ".3" man page type files. However, only a very limited number of files has content (e.g. datasets.3), most files are empty or nearly empty (e.g. nc_inq_nvars.3). Besides, "make install" doesn't install any of them under "share".

Thank you for any suggestions and help.

Gus Correa

gus-correa avatar Jan 06 '23 21:01 gus-correa

Hi Gus, the documentation, when built, does not install, but I suppose there's no reason for it not to. I can update this so that the generated files are installed under share, or whatever prefix is specified at configure time. So I guess, at this point, the behavior you're seeing isn't what is ideal, but it's not unexpected.

WardF avatar Jan 09 '23 20:01 WardF