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

Fix doxygen interference and some documentation issues #4376

Merged
merged 2 commits into from
Apr 11, 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
6 changes: 3 additions & 3 deletions .github/workflows/cmake-ctest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
- name: Install Dependencies
uses: ssciwr/doxygen-install@v1
with:
version: "1.10.0"
version: "1.9.7"

- name: Enable Developer Command Prompt
uses: ilammy/msvc-dev-cmd@v1.13.0
Expand Down Expand Up @@ -129,7 +129,7 @@ jobs:
- name: Install Dependencies
uses: ssciwr/doxygen-install@v1
with:
version: "1.10.0"
version: "1.9.7"

- name: Set file base name (Linux)
id: set-file-base
Expand Down Expand Up @@ -253,7 +253,7 @@ jobs:
- name: Install Dependencies
uses: ssciwr/doxygen-install@v1
with:
version: "1.10.0"
version: "1.9.7"

- name: Set file base name (MacOS)
id: set-file-base
Expand Down
25 changes: 2 additions & 23 deletions bin/h5vers
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,6 @@ die "unable to read file: $NEWS\n" unless -r $file;
my $CONFIGURE = $file;
$CONFIGURE =~ s/[^\/]*$/..\/configure.ac/;
die "unable to read file: $CONFIGURE\n" unless -r $file;
# cpp_doc_config
my $CPP_DOC_CONFIG = $file;
$CPP_DOC_CONFIG =~ s/[^\/]*$/..\/c++\/src\/cpp_doc_config/;
die "unable to read file: $CPP_DOC_CONFIG\n" unless -r $file;
my $H5_JAVA = $file;
$H5_JAVA =~ s/[^\/]*$/..\/java\/src\/hdf\/hdf5lib\/H5.java/;
die "unable to read file: $H5_JAVA\n" unless -r $file;
Expand Down Expand Up @@ -253,7 +249,6 @@ if ($set) {
$RELEASE = "";
$NEWS = "";
$CONFIGURE = "";
$CPP_DOC_CONFIG = "";
$LT_VERS = "";
$HDF5CONFIGCMAKE = "";
@newver = @curver;
Expand Down Expand Up @@ -348,22 +343,6 @@ if ($NEWS) {
close FILE;
}

# Update the c++/src/cpp_doc_config file
if ($CPP_DOC_CONFIG) {
my $data = read_file($CPP_DOC_CONFIG);
my $sub_rel_ver_str = (
$newver[3] eq ""
? sprintf("%s", "")
: sprintf("%s", "-".$newver[3].", currently under development")
);
my $version_string = sprintf("\"%d.%d.%d%s%s\"",
@newver[0,1,2],
$sub_rel_ver_str);
$data =~ s/PROJECT_NUMBER\s*=.*/PROJECT_NUMBER = $version_string/;

write_file($CPP_DOC_CONFIG, $data);
}

# Update the config/cmake/scripts/HDF5config.cmake file
if ($HDF5CONFIGCMAKE) {
my $data = read_file($HDF5CONFIGCMAKE);
Expand Down Expand Up @@ -427,7 +406,7 @@ if ($REPACK_LAYOUT_PLUGIN_VERSION) {
write_file($REPACK_LAYOUT_PLUGIN_VERSION, $data);
}

# helper function to read the file for updating c++/src/cpp_doc_config,
# helper function to read the file for updating
# config/cmake/scripts/HDF5Config.cmake, and java files.
# The version string in that file is not at the top, so the string replacement
# is not for the first line, and reading/writing the entire file as one string
Expand All @@ -444,7 +423,7 @@ sub read_file {
return $all;
}

# helper function to write the file for updating c++/src/cpp_doc_config,
# helper function to write the file for updating
# config/cmake/scripts/HDF5config.cmake and java files.
sub write_file {
my ($filename, $content) = @_;
Expand Down
18 changes: 0 additions & 18 deletions bin/release
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,6 @@ today=`date +%Y%m%d`
pmode='no'
revmode='no'
tmpdir="../#release_tmp.$$" # tmp work directory
CPPLUS_RM_NAME=cpplus_RM
MAINT_MODE_ENABLED=""

# If maintainer mode is enabled in configure, it should be disabled for release,
Expand Down Expand Up @@ -502,23 +501,6 @@ for comp in $methods; do
tar2cmakezip $HDF5_VERS $tmpdir/$HDF5_VERS.tar $DEST/CMake-$HDF5_VERS.zip 1>&2
(cd $DEST; sha256sum CMake-$HDF5_VERS.zip > CMake-$HDF5_VERS.zip.sha256)
;;
doc)
if [ "${DOCVERSION}" = "" ]; then
DOCVERSION=master
fi
test "$verbose" && echo " Creating docs..." 1>&2
# Check out docs from git repo
(cd $tmpdir; git clone -q $DOC_URL ${DOCVERSION} > /dev/null) || exit 1
# Create doxygen C++ RM
(cd c++/src && doxygen cpp_doc_config > /dev/null ) || exit 1
# Replace version of C++ RM with just-created version
rm -rf $tmpdir/${DOCVERSION}/html/$CPPLUS_RM_NAME || exit 1
mv c++/src/$CPPLUS_RM_NAME $tmpdir/${DOCVERSION}/html/$CPPLUS_RM_NAME || exit 1
# Compress the docs and move them to the release area
mv $tmpdir/${DOCVERSION} $tmpdir/${HDF5_VERS}_docs || exit 1
(cd $tmpdir && tar cf ${HDF5_VERS}_docs.tar ${HDF5_VERS}_docs) || exit 1
mv $tmpdir/${HDF5_VERS}_docs.tar $DEST || exit 1
;;
*)
echo "***Error*** Unknown method $comp"
exit 1
Expand Down
Loading
Loading