summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2023-11-15 23:32:07 (GMT)
committerGitHub <noreply@github.com>2023-11-15 23:32:07 (GMT)
commitef39882fa1e13740d2530c7a0637bd1f1a822b68 (patch)
treec4e44a5c35a019e170d9bf65470d5f0e7b9bc44f
parentfe49c075ac906f10fbcb08badcc68a8d79d216f1 (diff)
downloadhdf5-ef39882fa1e13740d2530c7a0637bd1f1a822b68.zip
hdf5-ef39882fa1e13740d2530c7a0637bd1f1a822b68.tar.gz
hdf5-ef39882fa1e13740d2530c7a0637bd1f1a822b68.tar.bz2
Change dest for doxygen (#3856)
* Switch doxygen refs to hdf5/develop
-rw-r--r--.github/workflows/release-files.yml1
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--doc/branches-explained.md2
-rw-r--r--doxygen/dox/Overview.dox2
-rw-r--r--doxygen/examples/FileFormat.html2
-rw-r--r--src/H5Fmodule.h2
-rw-r--r--src/H5module.h8
7 files changed, 10 insertions, 9 deletions
diff --git a/.github/workflows/release-files.yml b/.github/workflows/release-files.yml
index f53086e..5a31544 100644
--- a/.github/workflows/release-files.yml
+++ b/.github/workflows/release-files.yml
@@ -162,4 +162,5 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ github.workspace }}/${{ steps.get-file-base.outputs.FILE_BASE }}.doxygen
+ destination_dir: develop
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a16e845..de81b1c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -125,7 +125,7 @@ Please make sure that you check the items applicable to your pull request:
* [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://portal.hdfgroup.org/display/HDF5/API+Compatibility+Macros)
* 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://docs.hdfgroup.org/hdf5/develop/_r_m_t.html)?
+ * [ ] Was the new function documented in the corresponding public header file using [Doxygen](https://hdfgroup.github.io/hdf5/develop/_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?
diff --git a/doc/branches-explained.md b/doc/branches-explained.md
index 5b55ec7..f2aa627 100644
--- a/doc/branches-explained.md
+++ b/doc/branches-explained.md
@@ -2,7 +2,7 @@
This document describes current HDF5 branches.
-Branches are tested nightly and testing results are available at https://cdash-internal.hdfgroup.org/ and https://cdash.hdfgroup.org/.
+Branches are tested nightly and testing results are available at https://cdash.hdfgroup.org/.
Commits that break daily testing should be fixed by 3:00 pm Central time or reverted.
We encourage code contributors to check the status of their commits. If you have any questions, please contact help@hdfgroup.org.
diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox
index 438788e..414c071 100644
--- a/doxygen/dox/Overview.dox
+++ b/doxygen/dox/Overview.dox
@@ -23,7 +23,7 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
\par Versions
Version-specific documentation (see the version in the title area) can be found
here:
- - <a href="https://hdfgroup.github.io/hdf5/index.html">HDF5 <code>develop</code> branch (this site)</a>
+ - <a href="https://hdfgroup.github.io/hdf5/develop/index.html">HDF5 <code>develop</code> branch (this site)</a>
- <a href="https://hdfgroup.github.io/hdf5/v1_14/index.html">HDF5 1.14.x</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_12/index.html">HDF5 1.12.x</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_10/index.html">HDF5 1.10.x</a>
diff --git a/doxygen/examples/FileFormat.html b/doxygen/examples/FileFormat.html
index 133bbc8..0eb56d3 100644
--- a/doxygen/examples/FileFormat.html
+++ b/doxygen/examples/FileFormat.html
@@ -36,7 +36,7 @@ TABLE CAPTION STRONG { font-size: larger }
</li><li><h3><u>Background Reading:</u></h3>
<dl>
- <dt><a href="https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
+ <dt><a href="https://hdfgroup.github.io/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
</dt><dd>This describes the current HDF5 file format.
</dd></dl>
diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h
index 40ff6b4..b7bb7a0 100644
--- a/src/H5Fmodule.h
+++ b/src/H5Fmodule.h
@@ -705,7 +705,7 @@
* If the application opens an HDF5 file without both determining the driver used to create the file
* and setting up the use of that driver, the HDF5 Library will examine the superblock and the
* driver definition block to identify the driver.
- * See the <a href="https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
+ * See the <a href="https://hdfgroup.github.io/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
* for detailed descriptions of the superblock and the driver definition block.
*
* \subsubsection subsubsec_file_alternate_drivers_sec2 The POSIX (aka SEC2) Driver
diff --git a/src/H5module.h b/src/H5module.h
index 0d2a0ba..052fe5b 100644
--- a/src/H5module.h
+++ b/src/H5module.h
@@ -49,7 +49,7 @@
* The <em>Abstract Data Model</em> is a conceptual model of data, data types, and data organization. The
* abstract data model is independent of storage medium or programming environment. The
* <em>Storage Model</em> is a standard representation for the objects of the abstract data model. The
- * <a href="https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
+ * <a href="https://hdfgroup.github.io/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
* defines the storage model.
*
* The <em>Programming Model</em> is a model of the computing environment and includes platforms from
@@ -100,7 +100,7 @@
* model, and stored in a storage medium. The stored objects include header blocks, free lists, data
* blocks, B-trees, and other objects. Each group or dataset is stored as one or more header and data
* blocks.
- * @see <a href="https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
+ * @see <a href="https://hdfgroup.github.io/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
* for more information on how these objects are organized. The HDF5 library can also use other
* libraries and modules such as compression.
*
@@ -125,7 +125,7 @@
* HDF5 abstract data model is up to the application developer. The application program only
* needs to deal with the library and the abstract data model. Most applications need not consider
* any details of the
- * <a href="https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
+ * <a href="https://hdfgroup.github.io/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
* or the details of how objects of abstract data model are translated to and from storage.
*
* \subsection subsec_data_model_abstract The Abstract Data Model
@@ -408,7 +408,7 @@
*
* \subsection subsec_data_model_storage The HDF5 Storage Model
* \subsubsection subsubsec_data_model_storage_spec The Abstract Storage Model: the HDF5 Format Specification
- * The <a href="https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
+ * The <a href="https://hdfgroup.github.io/hdf5/develop/_s_p_e_c.html">HDF5 File Format Specification</a>
* defines how HDF5 objects and data are mapped to a linear
* address space. The address space is assumed to be a contiguous array of bytes stored on some
* random access medium. The format defines the standard for how the objects of the abstract data