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

Parse doxygen tag files #1043

Merged
merged 10 commits into from
Aug 27, 2023
Merged

Conversation

mkitti
Copy link
Member

@mkitti mkitti commented Jan 25, 2023

I parsed the Doxygen tag file and generated a tab separated value file, hdf5_func_urls.tsv

The next step is to use these URLs when generating the documentation.

@mkitti mkitti force-pushed the mkitti/parse_doxygen_tag_files branch from 6eafbd2 to 355604f Compare January 25, 2023 07:18
@simonbyrne
Copy link
Collaborator

Haha, I had been working on this as well. I'll open a draft PR with what I have, maybe we can combine.

@mkitti
Copy link
Member Author

mkitti commented Feb 2, 2023

I'm still interested in taking some ideas from #1044 such as replacing the for loop with a xpath query, but I"m running short on time.

@mkitti mkitti marked this pull request as ready for review February 2, 2023 09:11
@mkitti
Copy link
Member Author

mkitti commented Feb 3, 2023

We still need to modify h5doc:

h5doc(name) = "[`$name`](https://portal.hdfgroup.org/display/HDF5/$(name))"

@mkitti mkitti added this to the 0.17.0 milestone Jun 29, 2023
@mkitti
Copy link
Member Author

mkitti commented Aug 27, 2023

I changed this to use the HDF5 v1.14 documentation rather than develop to narrow the gap with #1044.

I'm going to merge this over #1044. My main reasons for preferring this over #1044 are as follows.

  • Here in 1043, the documentation URLs are statically embedded statically at generate time within the documentation rather than at parse time via macro that does that a xpath lookup.
  • The generation step here does a single pass over the XML tag file to generate a tsv file that is easily converted into a Julia Dict. The xpath lookup ends up multiple passes over the XML file.

I do want to revisit some of the ideas in #1044 later, especially with a pure Julia XML parser.

The current errors are due HDF5_jll binaries losing SZIP support. That should be fixed shortly with HDF5 1.14.2.

@mkitti mkitti merged commit b5a5268 into JuliaIO:master Aug 27, 2023
13 of 16 checks passed
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

Successfully merging this pull request may close these issues.

None yet

2 participants