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

[docs] auth.html is out of date and is not "officially" included in docs site

Open RandallPittmanOrSt opened this issue 1 year ago • 4 comments

In docs version 4.9.0+, auth.html ("netCDF Authorization Support") is not included in the main docs. That is to say, it's not in the sidebar TOC nor the "navigation" part of the docs site, and it is missing the CSS theming of the rest of the docs site. An old version appears at https://docs.unidata.ucar.edu/netcdf-c/current/auth.html but that is not up-to-date with https://github.com/Unidata/netcdf-c/blob/main/docs/auth.md

I don't understand how the docs are generated, but it looks like auth.md was dropped from docs/Doxyfile.in in commit b07f1cd, though I don't know if that's the main issue. It is still available in the 4.8.1 docs via the sidebar link "NetCDF Authorization Support".

This all comes from me trying to figure out what in the world nc_rc_get does, which the netCDF4-python just added bindings for.

RandallPittmanOrSt avatar Jul 24 '24 21:07 RandallPittmanOrSt

Thank you for catching this, and just in the nick of time, the 4.9.3 release candidate 1 is going out tomorrow. I'll get this sorted out!

WardF avatar Jul 24 '24 22:07 WardF

@WardF Will the html file be named "auth.html" or "md_auth.html" like before, or something else?

RandallPittmanOrSt avatar Jul 25 '24 16:07 RandallPittmanOrSt

The filename is autogenerated by doxygen, but should be in line with md_auth.html.

WardF avatar Jul 25 '24 20:07 WardF

See https://github.com/Unidata/netcdf-c/pull/2956

DennisHeimbigner avatar Jul 30 '24 21:07 DennisHeimbigner