Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
RandallPittmanOrSt opened this issue Jul 24, 2024 · 4 comments

Comments

@RandallPittmanOrSt
Copy link

RandallPittmanOrSt commented Jul 24, 2024

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 RandallPittmanOrSt changed the title [docs] auth.md is not "officially" included in docs site [docs] auth.html is out of date and is not "officially" included in docs site Jul 24, 2024
@WardF
Copy link
Member

WardF commented Jul 24, 2024

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!

@RandallPittmanOrSt
Copy link
Author

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

@WardF
Copy link
Member

WardF commented Jul 25, 2024

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

DennisHeimbigner added a commit to DennisHeimbigner/netcdf-c that referenced this issue Jul 30, 2024
re: Issue Unidata#2952

The documentation -- such as it is -- is lost inside
docs/auth.md. So, create docs/quickstart_env.md to describe how
.rc file mechanism is used, and include the netcdf-c API.  Also
add list of environment variables used by the netcdf-c library.
@DennisHeimbigner
Copy link
Collaborator

See #2956

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants