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

several link changes for doxygen and changes for deep links into doxygen itself #299

Open
lkurz opened this issue Aug 28, 2024 · 2 comments
Labels
Doxygen Issue help wanted Extra attention is needed

Comments

@lkurz
Copy link
Collaborator

lkurz commented Aug 28, 2024

Several links for doxygen need to be identified and changed:

  1. https://hdfgroup.github.io/hdf5/v1_14//_h_d_f5_examples.html
    These links are for the github pages repo space which should not appear on support site or in documentation:

  2. This is also an example of a deep link into the doxygen file structure.
    "_h_d_f5_examples.html"
    I think I know the answer is no or not yet. But are we using "anchors" in the doxygen code to which we can create deep and intelligible links into a doxygen space?

For Example
Suppose you have a function documented in Doxygen:
/// \anchor my_function
/// This is my function.
void myFunction();

In the external HTML page, you can link to this function using the tag file:
Link to myFunction

  1. the following links to docs hdf5 directory point to https://docs.hdfgroup.org/releases/hdf5/latest-docs.html OR
    https://docs.hdfgroup.org/releases/hdf5/v1_14/v1_14_4/documentation/doxygen/index.html

http://docs.hdfgroup.org/hdf5/v1_14/index.html
http://docs.hdfgroup.org/hdf5/develop/index.html. < we actually don't want doxygen from develop branch on support site.

https://docs.hdfgroup.org/hdf5 should go away.

@lkurz
Copy link
Collaborator Author

lkurz commented Aug 30, 2024

The following files have many links to portal.hdfgroup.org/hdf5/ which is the develop branch github-pages build.
Currently these links are not failing, but should be changed to the proper intended doxygen release(s) for each file.

image

@lkurz
Copy link
Collaborator Author

lkurz commented Oct 3, 2024

Move issue to HDF5.

@lkurz lkurz added the help wanted Extra attention is needed label Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doxygen Issue help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant