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

Use the correct doxygen URL in 1.14 branches #4844

Merged
merged 1 commit into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ Please make sure that you check the items applicable to your pull request:
* [ ] If changes were done to Autotools build, were they added to CMake and vice versa?
* [ ] Is the pull request applicable to any other branches? If yes, which ones? Please document it in the GitHub issue.
* [ ] Is the new code sufficiently documented for future maintenance?
* [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://hdfgroup.github.io/hdf5/v1_14/api-compat-macros.html)
* [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/api-compat-macros.html)
* Documentation
* [ ] Was the change described in the release_docs/RELEASE.txt file?
* [ ] Was the new function documented in the corresponding public header file using [Doxygen](https://hdfgroup.github.io/hdf5/v1_14/_r_m_t.html)?
* [ ] Was the new function documented in the corresponding public header file using [Doxygen](https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_r_m_t.html)?
* [ ] Was new functionality documented for the HDF5 community (the level of documentation depends on the feature; ask us what would be appropriate)
* Testing
* [ ] Does the pull request have tests?
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ DOCUMENTATION
-------------
This release is fully functional for the API described in the documentation.

https://hdfgroup.github.io/hdf5/v1_14/_l_b_a_p_i.html
https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_l_b_a_p_i.html

Full Documentation and Programming Resources for this release can be found at

https://hdfgroup.github.io/hdf5/v1_14/index.html
https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/index.html

The latest doxygen documentation generated on changes to HDF5 1.14.x is available at:

https://hdfgroup.github.io/hdf5/v1_14
https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen

See the [RELEASE.txt](release_docs/RELEASE.txt) file in the [release_docs/](release_docs/) directory for information specific
to the features and updates included in this release of the library.
Expand Down
22 changes: 11 additions & 11 deletions doc/parallel-compression.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,17 +335,17 @@ hid_t file_id = H5Fcreate("file.h5", H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id);

[u1]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/HDF5Examples/C/H5PAR/ph5_filtered_writes.c
[u2]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/HDF5Examples/C/H5PAR/ph5_filtered_writes_no_sel.c
[u3]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___h5_d.html#gaf6213bf3a876c1741810037ff2bb85d8
[u4]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___h5_d.html#ga8eb1c838aff79a17de385d0707709915
[u5]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851
[u6]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4
[u7]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2
[u3]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___h5_d.html#gaf6213bf3a876c1741810037ff2bb85d8
[u4]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___h5_d.html#ga8eb1c838aff79a17de385d0707709915
[u5]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851
[u6]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4
[u7]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2
[u8]: https://www.hdfgroup.org/2022/03/04/parallel-compression-improvements-in-hdf5-1-13-1/
[u9]: https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/chunking_in_hdf5.md
[u10]: https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/HDF5ImprovingIOPerformanceCompressedDatasets.pdf
[u11]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_a_p_l.html#gab99d5af749aeb3896fd9e3ceb273677a
[u12]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_c_p_l.html#ga167ff65f392ca3b7f1933b1cee1b9f70
[u13]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_c_p_l.html#gad012d7f3c2f1e1999eb1770aae3a4963
[u14]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_x_p_l.html#ga001a22b64f60b815abf5de8b4776f09e
[u15]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_x_p_l.html#gacb30d14d1791ec7ff9ee73aa148a51a3
[u16]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910
[u11]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_a_p_l.html#gab99d5af749aeb3896fd9e3ceb273677a
[u12]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_c_p_l.html#ga167ff65f392ca3b7f1933b1cee1b9f70
[u13]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_c_p_l.html#gad012d7f3c2f1e1999eb1770aae3a4963
[u14]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_x_p_l.html#ga001a22b64f60b815abf5de8b4776f09e
[u15]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_x_p_l.html#gacb30d14d1791ec7ff9ee73aa148a51a3
[u16]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910
2 changes: 1 addition & 1 deletion doxygen/aliases
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ALIASES += DWNURL="\HDFURL/releases/hdf5/downloads"
ALIASES += RFCURL="\DOCURL/rfc"
ALIASES += AEXURL="\HDFURL/archive/support/ftp/HDF5/examples"
# doxygen subdir (develop, v1_14)
ALIASES += DOXURL="hdfgroup.github.io/hdf5/v1_14"
ALIASES += DOXURL="support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen"
#branch name (develop, hdf5_1_14)
ALIASES += SRCURL="github.com/HDFGroup/hdf5/blob/hdf5_1_14"
#Other projects that contribute to HDF5
Expand Down
4 changes: 2 additions & 2 deletions doxygen/examples/H5.format.1.1.html
Original file line number Diff line number Diff line change
Expand Up @@ -5558,8 +5558,8 @@ <h4><a name="FilterMessage">Name: Data Storage - Filter Pipeline</a></h4>
<a name="Footnote1Change"><sup>1</sup></a>If you are reading
an earlier version of this document, this link may have changed.
If the link does not work, use the latest version of this document
on <a href="https://hdfgroup.github.io/hdf5/develop/index.html">The HDF Group</a>&rsquo;s website,
<a href="https://hdfgroup.github.io/hdf5/develop/_f_m_t11.html">
on <a href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/index.html">The HDF Group</a>&rsquo;s website,
<a href="https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_f_m_t11.html">
<code>H5.format.html</code></a>;
the link there will always be correct.
<small><a href="#FilterMessage">(Return)</a>
Expand Down
2 changes: 1 addition & 1 deletion release_docs/INSTALL_Autotools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ III. Full installation instructions for source distributions
source code. For additional configuration options and other details,
see "API Compatibility Macros":

https://hdfgroup.github.io/hdf5/v1_14/api-compat-macros.html
https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/api-compat-macros.html

4. Building
The library, confidence tests, and programs can be built by
Expand Down
2 changes: 1 addition & 1 deletion release_docs/RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,6 @@ For more information on the HDF5 versioning and backward and forward compatibili
[u10]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/bin/h5vers
[u11]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/src/CMakeLists.txt
[u12]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/configure.ac
[u13]: https://hdfgroup.github.io/hdf5/v1_14/api-compat-macros.html
[u13]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/api-compat-macros.html
[u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.14
[u15]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot
4 changes: 2 additions & 2 deletions test/API/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# HDF5 API Tests

This directory contains several test applications that exercise HDF5's
public API and serve as regression tests for HDF5 [VOL Connectors](https://hdfgroup.github.io/hdf5/v1_14/_h5_v_l__u_g.html).
public API and serve as regression tests for HDF5 [VOL Connectors](https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_v_l__u_g.html).

## Build Process and options

Expand Down Expand Up @@ -42,7 +42,7 @@ Currently unsupported

These API tests currently only support usage with the native HDF5 VOL connector and HDF5 VOL
connectors that can be loaded dynamically as a plugin. For information on how to build a VOL
connector in this manner, refer to section 2.3 of the [HDF5 VOL Connector Author Guide](https://hdfgroup.github.io/hdf5/v1_14/_v_o_l__connector.html).
connector in this manner, refer to section 2.3 of the [HDF5 VOL Connector Author Guide](https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_v_o_l__connector.html).

TODO: section on building VOL connectors alongside HDF5 for use with tests

Expand Down
Loading