From ef39882fa1e13740d2530c7a0637bd1f1a822b68 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Wed, 15 Nov 2023 17:32:07 -0600 Subject: Change dest for doxygen (#3856) * Switch doxygen refs to hdf5/develop --- .github/workflows/release-files.yml | 1 + CONTRIBUTING.md | 2 +- doc/branches-explained.md | 2 +- doxygen/dox/Overview.dox | 2 +- doxygen/examples/FileFormat.html | 2 +- src/H5Fmodule.h | 2 +- src/H5module.h | 8 ++++---- 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: - - HDF5 develop branch (this site) + - HDF5 develop branch (this site) - HDF5 1.14.x - HDF5 1.12.x - HDF5 1.10.x 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 }

  • Background Reading:

    -
    HDF5 File Format Specification +
    HDF5 File Format Specification
    This describes the current HDF5 file format.
    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 HDF5 File Format Specification + * See the HDF5 File Format Specification * 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 Abstract Data Model is a conceptual model of data, data types, and data organization. The * abstract data model is independent of storage medium or programming environment. The * Storage Model is a standard representation for the objects of the abstract data model. The - * HDF5 File Format Specification + * HDF5 File Format Specification * defines the storage model. * * The Programming Model 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 HDF5 File Format Specification + * @see HDF5 File Format Specification * 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 - * HDF5 File Format Specification + * HDF5 File Format Specification * 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 HDF5 File Format Specification + * The HDF5 File Format Specification * 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 -- cgit v0.12