Skip to content

Commit b42c2a2

Browse files
mkittimkitti
authored
Update links to HDF5 documentation on support.hdfgroup.org (#1193)
1 parent ebaaeee commit b42c2a2

File tree

7 files changed

+39017
-36905
lines changed

7 files changed

+39017
-36905
lines changed

‎docs/src/api_bindings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1052,7 +1052,7 @@ h5z_unregister
10521052

10531053
---
10541054

1055-
## [[`H5FD`](https://docs.hdfgroup.org/hdf5/v1_14/_v_f_l.html) — File Drivers](@id H5FD)
1055+
## [[`H5FD`](https://docs.hdfgroup.org/hdf5/v1_14/) — File Drivers](@id H5FD)
10561056
- [`h5fd_core_init`](@ref h5fd_core_init)
10571057
- [`h5fd_family_init`](@ref h5fd_family_init)
10581058
- [`h5fd_log_init`](@ref h5fd_log_init)

‎gen/DoxygenTagParser/hdf5.tag

+36,904-34,961
Large diffs are not rendered by default.

‎gen/DoxygenTagParser/hdf5_func_urls.tsv

+1,529-1,436
Large diffs are not rendered by default.

‎gen/DoxygenTagParser/hdf5_group_urls.tsv

+65-5
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,32 @@ ATOM https://docs.hdfgroup.org/hdf5/v1_14/group___a_t_o_m.html
77
About https://docs.hdfgroup.org/hdf5/v1_14/_about.html
88
Accessibility https://docs.hdfgroup.org/hdf5/v1_14/_accessibility.html
99
Attributes https://docs.hdfgroup.org/hdf5/v1_14/_attributes.html
10+
BRANCHEXPL https://docs.hdfgroup.org/hdf5/v1_14/_b_r_a_n_c_h_e_x_p_l.html
11+
CALLBACKS https://docs.hdfgroup.org/hdf5/v1_14/_c_a_l_l_b_a_c_k_s.html
12+
CMakeVols https://docs.hdfgroup.org/hdf5/v1_14/_c_make_vols.html
13+
CODECONV https://docs.hdfgroup.org/hdf5/v1_14/_c_o_d_e_c_o_n_v.html
1014
COMPENUM https://docs.hdfgroup.org/hdf5/v1_14/group___c_o_m_p_e_n_u_m.html
1115
COMPOUND https://docs.hdfgroup.org/hdf5/v1_14/group___c_o_m_p_o_u_n_d.html
1216
CONV https://docs.hdfgroup.org/hdf5/v1_14/group___c_o_n_v.html
17+
CommandTools https://docs.hdfgroup.org/hdf5/v1_14/_command_tools.html
18+
CompTS https://docs.hdfgroup.org/hdf5/v1_14/_comp_t_s.html
1319
Cookbook https://docs.hdfgroup.org/hdf5/v1_14/_cookbook.html
1420
DAPL https://docs.hdfgroup.org/hdf5/v1_14/group___d_a_p_l.html
1521
DCPL https://docs.hdfgroup.org/hdf5/v1_14/group___d_c_p_l.html
1622
DDLBNF110 https://docs.hdfgroup.org/hdf5/v1_14/_d_d_l_b_n_f110.html
1723
DDLBNF112 https://docs.hdfgroup.org/hdf5/v1_14/_d_d_l_b_n_f112.html
24+
DDLBNF114 https://docs.hdfgroup.org/hdf5/v1_14/_d_d_l_b_n_f114.html
1825
DXPL https://docs.hdfgroup.org/hdf5/v1_14/group___d_x_p_l.html
1926
ENUM https://docs.hdfgroup.org/hdf5/v1_14/group___e_n_u_m.html
2027
ERRORS https://docs.hdfgroup.org/hdf5/v1_14/_e_r_r_o_r_s.html
2128
ERRORSLIB https://docs.hdfgroup.org/hdf5/v1_14/_e_r_r_o_r_s_l_i_b.html
29+
ExAPI https://docs.hdfgroup.org/hdf5/v1_14/_ex_a_p_i.html
2230
FAPL https://docs.hdfgroup.org/hdf5/v1_14/group___f_a_p_l.html
2331
FCPL https://docs.hdfgroup.org/hdf5/v1_14/group___f_c_p_l.html
2432
FH5 https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5.html
2533
FH5A https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_a.html
2634
FH5D https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_d.html
35+
FH5DO https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_d_o.html
2736
FH5DS https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_d_s.html
2837
FH5E https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_e.html
2938
FH5ES https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_e_s.html
@@ -41,15 +50,14 @@ FH5T https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_t.html
4150
FH5TB https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_t_b.html
4251
FH5VL https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_v_l.html
4352
FH5Z https://docs.hdfgroup.org/hdf5/v1_14/group___f_h5_z.html
44-
FILTER https://docs.hdfgroup.org/hdf5/v1_14/_f_i_l_t_e_r.html
4553
FLETCHER32 https://docs.hdfgroup.org/hdf5/v1_14/group___f_l_e_t_c_h_e_r32.html
4654
FMPL https://docs.hdfgroup.org/hdf5/v1_14/group___f_m_p_l.html
4755
FMT1 https://docs.hdfgroup.org/hdf5/v1_14/_f_m_t1.html
4856
FMT11 https://docs.hdfgroup.org/hdf5/v1_14/_f_m_t11.html
4957
FMT2 https://docs.hdfgroup.org/hdf5/v1_14/_f_m_t2.html
50-
FMT3 https://docs.hdfgroup.org/hdf5/v1_14/_f_m_t3.html
5158
FMTDISC https://docs.hdfgroup.org/hdf5/v1_14/_f_m_t_d_i_s_c.html
5259
FTS https://docs.hdfgroup.org/hdf5/v1_14/_f_t_s.html
60+
FileLock https://docs.hdfgroup.org/hdf5/v1_14/_file_lock.html
5361
Files https://docs.hdfgroup.org/hdf5/v1_14/_files.html
5462
GAPL https://docs.hdfgroup.org/hdf5/v1_14/group___g_a_p_l.html
5563
GCPL https://docs.hdfgroup.org/hdf5/v1_14/group___g_c_p_l.html
@@ -71,6 +79,7 @@ H5ES https://docs.hdfgroup.org/hdf5/v1_14/group___h5_e_s.html
7179
H5ES_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_e_s__u_g.html
7280
H5E_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_e__u_g.html
7381
H5F https://docs.hdfgroup.org/hdf5/v1_14/group___h5_f.html
82+
H5FIM_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_f_i_m__u_g.html
7483
H5F_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_f__u_g.html
7584
H5G https://docs.hdfgroup.org/hdf5/v1_14/group___h5_g.html
7685
H5G_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_g__u_g.html
@@ -102,7 +111,23 @@ H5S_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_s__u_g.html
102111
H5T https://docs.hdfgroup.org/hdf5/v1_14/group___h5_t.html
103112
H5TB https://docs.hdfgroup.org/hdf5/v1_14/group___h5_t_b.html
104113
H5TB_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_b__u_g.html
114+
H5TOOL_CP_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__c_p__u_g.html
115+
H5TOOL_CR_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__c_r__u_g.html
116+
H5TOOL_DF_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__d_f__u_g.html
117+
H5TOOL_DG_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__d_g__u_g.html
118+
H5TOOL_DP_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__d_p__u_g.html
119+
H5TOOL_DT_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__d_t__u_g.html
120+
H5TOOL_FC_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__f_c__u_g.html
121+
H5TOOL_IM_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__i_m__u_g.html
122+
H5TOOL_JAM_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__j_a_m__u_g.html
123+
H5TOOL_LS_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__l_s__u_g.html
124+
H5TOOL_MG_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__m_g__u_g.html
125+
H5TOOL_RP_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__r_p__u_g.html
126+
H5TOOL_RT_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__r_t__u_g.html
127+
H5TOOL_ST_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__s_t__u_g.html
128+
H5TOOL_WH_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t_o_o_l__w_h__u_g.html
105129
H5T_UG https://docs.hdfgroup.org/hdf5/v1_14/_h5_t__u_g.html
130+
H5VFD https://docs.hdfgroup.org/hdf5/v1_14/group___h5_v_f_d.html
106131
H5VL https://docs.hdfgroup.org/hdf5/v1_14/group___h5_v_l.html
107132
H5VLDEF https://docs.hdfgroup.org/hdf5/v1_14/group___h5_v_l_d_e_f.html
108133
H5VLDEV https://docs.hdfgroup.org/hdf5/v1_14/group___h5_v_l_d_e_v.html
@@ -117,9 +142,17 @@ HDF5CONST https://docs.hdfgroup.org/hdf5/v1_14/_h_d_f5_c_o_n_s_t.html
117142
HDF5Examples https://docs.hdfgroup.org/hdf5/v1_14/_h_d_f5_examples.html
118143
HDF5LIB https://docs.hdfgroup.org/hdf5/v1_14/_h_d_f5_l_i_b.html
119144
HDFNATIVE https://docs.hdfgroup.org/hdf5/v1_14/_h_d_f_n_a_t_i_v_e.html
145+
HTML_IMGS https://docs.hdfgroup.org/hdf5/v1_14/_h_t_m_l__i_m_g_s.html
120146
IMG https://docs.hdfgroup.org/hdf5/v1_14/_i_m_g.html
121147
IOFLOW https://docs.hdfgroup.org/hdf5/v1_14/_i_o_f_l_o_w.html
148+
InitShut https://docs.hdfgroup.org/hdf5/v1_14/_init_shut.html
122149
IntroHDF5 https://docs.hdfgroup.org/hdf5/v1_14/_intro_h_d_f5.html
150+
IntroParChunk https://docs.hdfgroup.org/hdf5/v1_14/_intro_par_chunk.html
151+
IntroParContHyperslab https://docs.hdfgroup.org/hdf5/v1_14/_intro_par_cont_hyperslab.html
152+
IntroParHDF5 https://docs.hdfgroup.org/hdf5/v1_14/_intro_par_h_d_f5.html
153+
IntroParPattern https://docs.hdfgroup.org/hdf5/v1_14/_intro_par_pattern.html
154+
IntroParRegularSpaced https://docs.hdfgroup.org/hdf5/v1_14/_intro_par_regular_spaced.html
155+
JCALLBK https://docs.hdfgroup.org/hdf5/v1_14/group___j_c_a_l_l_b_k.html
123156
JERR https://docs.hdfgroup.org/hdf5/v1_14/group___j_e_r_r.html
124157
JERRJAVA https://docs.hdfgroup.org/hdf5/v1_14/group___j_e_r_r_j_a_v_a.html
125158
JERRLIB https://docs.hdfgroup.org/hdf5/v1_14/group___j_e_r_r_l_i_b.html
@@ -150,8 +183,9 @@ LBTraining https://docs.hdfgroup.org/hdf5/v1_14/_l_b_training.html
150183
LCPL https://docs.hdfgroup.org/hdf5/v1_14/group___l_c_p_l.html
151184
LearnBasics https://docs.hdfgroup.org/hdf5/v1_14/_learn_basics.html
152185
LearnHDFView https://docs.hdfgroup.org/hdf5/v1_14/_learn_h_d_f_view.html
186+
MAPL https://docs.hdfgroup.org/hdf5/v1_14/group___m_a_p_l.html
153187
MDC https://docs.hdfgroup.org/hdf5/v1_14/group___m_d_c.html
154-
MT https://docs.hdfgroup.org/hdf5/v1_14/_m_t.html
188+
NBIT https://docs.hdfgroup.org/hdf5/v1_14/group___n_b_i_t.html
155189
OCPL https://docs.hdfgroup.org/hdf5/v1_14/group___o_c_p_l.html
156190
OCPYPL https://docs.hdfgroup.org/hdf5/v1_14/group___o_c_p_y_p_l.html
157191
OPAQUE https://docs.hdfgroup.org/hdf5/v1_14/group___o_p_a_q_u_e.html
@@ -169,7 +203,9 @@ PDTX86 https://docs.hdfgroup.org/hdf5/v1_14/group___p_d_t_x86.html
169203
PH5F https://docs.hdfgroup.org/hdf5/v1_14/group___p_h5_f.html
170204
PLCR https://docs.hdfgroup.org/hdf5/v1_14/group___p_l_c_r.html
171205
PLCRA https://docs.hdfgroup.org/hdf5/v1_14/group___p_l_c_r_a.html
206+
ParCompr https://docs.hdfgroup.org/hdf5/v1_14/_par_compr.html
172207
Performance https://docs.hdfgroup.org/hdf5/v1_14/_performance.html
208+
RELVERSION https://docs.hdfgroup.org/hdf5/v1_14/_r_e_l_v_e_r_s_i_o_n.html
173209
RFC https://docs.hdfgroup.org/hdf5/v1_14/_r_f_c.html
174210
RM https://docs.hdfgroup.org/hdf5/v1_14/_r_m.html
175211
RMT https://docs.hdfgroup.org/hdf5/v1_14/_r_m_t.html
@@ -178,15 +214,20 @@ SHUFFLE https://docs.hdfgroup.org/hdf5/v1_14/group___s_h_u_f_f_l_e.html
178214
SPEC https://docs.hdfgroup.org/hdf5/v1_14/_s_p_e_c.html
179215
STRCPL https://docs.hdfgroup.org/hdf5/v1_14/group___s_t_r_c_p_l.html
180216
SWMR https://docs.hdfgroup.org/hdf5/v1_14/group___s_w_m_r.html
217+
SWMRTN https://docs.hdfgroup.org/hdf5/v1_14/_s_w_m_r_t_n.html
181218
SZIP https://docs.hdfgroup.org/hdf5/v1_14/group___s_z_i_p.html
182219
TAPL https://docs.hdfgroup.org/hdf5/v1_14/group___t_a_p_l.html
183-
TBL https://docs.hdfgroup.org/hdf5/v1_14/_t_b_l.html
220+
TBLSPEC https://docs.hdfgroup.org/hdf5/v1_14/_t_b_l_s_p_e_c.html
184221
TCPL https://docs.hdfgroup.org/hdf5/v1_14/group___t_c_p_l.html
185222
TN https://docs.hdfgroup.org/hdf5/v1_14/_t_n.html
186223
TNMDC https://docs.hdfgroup.org/hdf5/v1_14/_t_n_m_d_c.html
187224
TRAV https://docs.hdfgroup.org/hdf5/v1_14/group___t_r_a_v.html
225+
ThrdSafe https://docs.hdfgroup.org/hdf5/v1_14/_thrd_safe.html
188226
UG https://docs.hdfgroup.org/hdf5/v1_14/_u_g.html
189-
VFL https://docs.hdfgroup.org/hdf5/v1_14/_v_f_l.html
227+
UNICODE https://docs.hdfgroup.org/hdf5/v1_14/_u_n_i_c_o_d_e.html
228+
UsingIdentifiers https://docs.hdfgroup.org/hdf5/v1_14/_using_identifiers.html
229+
VDSTN https://docs.hdfgroup.org/hdf5/v1_14/_v_d_s_t_n.html
230+
VFLTN https://docs.hdfgroup.org/hdf5/v1_14/_v_f_l_t_n.html
190231
VLEN https://docs.hdfgroup.org/hdf5/v1_14/group___v_l_e_n.html
191232
VOL_Connector https://docs.hdfgroup.org/hdf5/v1_14/_v_o_l__connector.html
192233
ViewTools https://docs.hdfgroup.org/hdf5/v1_14/_view_tools.html
@@ -196,6 +237,25 @@ ViewToolsEdit https://docs.hdfgroup.org/hdf5/v1_14/_view_tools_edit.html
196237
ViewToolsJPSS https://docs.hdfgroup.org/hdf5/v1_14/_view_tools_j_p_s_s.html
197238
ViewToolsView https://docs.hdfgroup.org/hdf5/v1_14/_view_tools_view.html
198239
api-compat-macros https://docs.hdfgroup.org/hdf5/v1_14/api-compat-macros.html
240+
collective_calls https://docs.hdfgroup.org/hdf5/v1_14/collective_calls.html
241+
collective_metadata_io https://docs.hdfgroup.org/hdf5/v1_14/collective_metadata_io.html
242+
copying_committed https://docs.hdfgroup.org/hdf5/v1_14/copying_committed.html
243+
freeing_memory https://docs.hdfgroup.org/hdf5/v1_14/freeing_memory.html
244+
hdf5_chunk_issues https://docs.hdfgroup.org/hdf5/v1_14/hdf5_chunk_issues.html
245+
hdf5_chunking https://docs.hdfgroup.org/hdf5/v1_14/hdf5_chunking.html
246+
improve_compressed_perf https://docs.hdfgroup.org/hdf5/v1_14/improve_compressed_perf.html
199247
index https://docs.hdfgroup.org/hdf5/v1_14/index.html
200248
maybe_metadata_reads https://docs.hdfgroup.org/hdf5/v1_14/maybe_metadata_reads.html
249+
md__c_o_d_e___o_f___c_o_n_d_u_c_t https://docs.hdfgroup.org/hdf5/v1_14/md__c_o_d_e___o_f___c_o_n_d_u_c_t.html
250+
md__c_o_n_t_r_i_b_u_t_i_n_g https://docs.hdfgroup.org/hdf5/v1_14/md__c_o_n_t_r_i_b_u_t_i_n_g.html
251+
md__c_v_e__list__1__14 https://docs.hdfgroup.org/hdf5/v1_14/md__c_v_e__list__1__14.html
252+
md__r_e_a_d_m_e https://docs.hdfgroup.org/hdf5/v1_14/md__r_e_a_d_m_e.html
253+
md__s_e_c_u_r_i_t_y https://docs.hdfgroup.org/hdf5/v1_14/md__s_e_c_u_r_i_t_y.html
254+
md_doxygen_2examples_2menus_2core__menu https://docs.hdfgroup.org/hdf5/v1_14/md_doxygen_2examples_2menus_2core__menu.html
255+
md_doxygen_2examples_2menus_2fortran__menu https://docs.hdfgroup.org/hdf5/v1_14/md_doxygen_2examples_2menus_2fortran__menu.html
256+
md_doxygen_2examples_2menus_2high__level__menu https://docs.hdfgroup.org/hdf5/v1_14/md_doxygen_2examples_2menus_2high__level__menu.html
257+
md_doxygen_2examples_2menus_2java__menu https://docs.hdfgroup.org/hdf5/v1_14/md_doxygen_2examples_2menus_2java__menu.html
258+
md_release__docs_2_r_e_l_e_a_s_e___p_r_o_c_e_s_s https://docs.hdfgroup.org/hdf5/v1_14/md_release__docs_2_r_e_l_e_a_s_e___p_r_o_c_e_s_s.html
259+
mod_region_writes https://docs.hdfgroup.org/hdf5/v1_14/mod_region_writes.html
201260
predefined_datatypes_tables https://docs.hdfgroup.org/hdf5/v1_14/predefined_datatypes_tables.html
261+
thread-safe-lib https://docs.hdfgroup.org/hdf5/v1_14/thread-safe-lib.html

‎gen/DoxygenTagParser/src/DoxygenTagParser.jl

+18-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,24 @@ struct HDF5GroupInfo
1818
filename::String
1919
end
2020

21-
const DEFAULT_URL_PREFIX = "https://docs.hdfgroup.org/hdf5/v1_14/"
22-
const HDF5_TAG_URL = "$(DEFAULT_URL_PREFIX)hdf5.tag"
21+
const DEFAULT_URL_PREFIX = "https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6/documentation/doxygen/"
22+
23+
"""
24+
To generate hdf5.tag from the HDF5 source code execute the following script.
25+
26+
```
27+
curl -fsSL https://pixi.sh/install.sh | bash
28+
pixi global install cmake
29+
pixi global install doxygen
30+
git clone https://github.com/HDFGroup/hdf5.git
31+
cd hdf5
32+
git checkout hdf5-1.14.6
33+
mkdir build
34+
cmake -D HDF5_BUILD_DOCS=ON ..
35+
make -j hdf5hllib_doc
36+
```
37+
"""
38+
const HDF5_TAG_URL = joinpath(dirname(@__DIR__), "hdf5.tag")
2339

2440
"""
2541
parse_tag_file(url)

‎gen/gen_wrappers.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ const group_url_dict = Dict{String,String}([
55
func_urls[1] => func_urls[2] for
66
func_urls in split.(readlines("DoxygenTagParser/hdf5_group_urls.tsv"))
77
])
8-
group_url_dict["H5FD"] = group_url_dict["VFL"]
8+
#group_url_dict["H5FD"] = group_url_dict["VFL"]
99

1010
include(joinpath(@__DIR__, "bind_generator.jl"))
1111

0 commit comments

Comments
 (0)