JuliaIO / HDF5.jl

Save and load data in the HDF5 file format from Julia
https://juliaio.github.io/HDF5.jl
MIT License
386 stars 140 forks source link

Parse doxygen tag files #1043

Closed mkitti closed 1 year ago

mkitti commented 1 year ago

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.

simonbyrne commented 1 year ago

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

mkitti commented 1 year ago

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 commented 1 year ago

We still need to modify h5doc: https://github.com/JuliaIO/HDF5.jl/blob/ffc0b66cdab5be3c8e29a637c4514c97d7e126d8/src/HDF5.jl#L65

mkitti commented 1 year ago

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.

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.