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

Convert doc folder files to doxygen #5216

Merged
merged 23 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
d689458
Convert doc folder files to doxygen
byrnHDF Jan 7, 2025
0c69598
Merge updates from develop
byrnHDF Jan 7, 2025
5e91f0e
Update secondary file on compression, referenced by other file.
byrnHDF Jan 8, 2025
e71d3aa
Add back missing ignore option in linkchecker
byrnHDF Jan 8, 2025
0788373
Update ignore list
byrnHDF Jan 8, 2025
08f112e
Correct reference to anchor
byrnHDF Jan 8, 2025
c2a1182
Correct references and URLs
byrnHDF Jan 8, 2025
b875bbc
Change URL to point to archive
byrnHDF Jan 8, 2025
f662786
Merge branch 'HDFGroup:develop' into develop-doxy-doc
byrnHDF Jan 9, 2025
c8e4524
Point URL to file
byrnHDF Jan 9, 2025
9211e7e
Correct doxygen command typos
byrnHDF Jan 9, 2025
cdee746
Committing clang-format changes
github-actions[bot] Jan 9, 2025
4dd224d
Add index file to URL
byrnHDF Jan 9, 2025
da17939
Merge branch 'HDFGroup:develop' into develop-doxy-doc
byrnHDF Jan 9, 2025
797a7b2
Add Collective Metadata I/O document to tech notes
byrnHDF Jan 9, 2025
174a374
Add IO performance with compressed datsets to doxygen
byrnHDF Jan 10, 2025
bb35927
Add image files
byrnHDF Jan 10, 2025
20f6476
Merge branch 'HDFGroup:develop' into develop-doxy-doc
byrnHDF Jan 13, 2025
67c61e4
Change URLs to new doxygen URLs
byrnHDF Jan 13, 2025
0a2c9d2
Merge branch 'HDFGroup:develop' into develop-doxy-doc
byrnHDF Jan 13, 2025
1f33f8d
Also fix http URLs
byrnHDF Jan 13, 2025
e888fcb
Fix long standing reference warnings
byrnHDF Jan 13, 2025
52590c9
Remove last archive reference
byrnHDF Jan 13, 2025
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
2 changes: 1 addition & 1 deletion .codespellrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
skip = .git,*.svg,.codespellrc,./bin/trace,./hl/tools/h5watch/h5watch.c,./tools/test/h5jam/tellub.c,./config/sanitizer/LICENSE,./config/sanitizer/sanitizers.cmake,./tools/test/h5import/testfiles/*.conf,./tools/test/h5repack/testfiles/*.dat,./test/API/driver,./configure,./bin/ltmain.sh,./bin/depcomp,./bin/config.guess,./bin/config.sub,./autom4te.cache,./m4/libtool.m4,./c++/src/*.html,./HDF5Examples/depcomp
check-hidden = true
# ignore-regex =
ignore-words-list = ot,isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp,ake,gord,numer,ro,oce,msdos,TEXTIN
ignore-words-list = ot,isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp,ake,gord,numer,ro,oce,msdos,TEXTIN,FLE
2 changes: 1 addition & 1 deletion .github/workflows/linkchecker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ jobs:
- name: check
run: |
cd build/hdf5lib_docs/html
linkchecker --check-extern ./index.html
linkchecker --ignore-url=/doxygen.css --check-extern ./index.html
continue-on-error: true

40 changes: 0 additions & 40 deletions doc/branches-explained.md

This file was deleted.

57 changes: 0 additions & 57 deletions doc/code-conventions.md

This file was deleted.

56 changes: 0 additions & 56 deletions doc/library-init-shutdown.md

This file was deleted.

16 changes: 0 additions & 16 deletions doc/threadsafety-warning.md

This file was deleted.

9 changes: 8 additions & 1 deletion doxygen/aliases
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ALIASES += DOXURL="hdfgroup.github.io/hdf5/develop"
#branch name (develop, hdf5_1_14)
ALIASES += SRCURL="github.com/HDFGroup/hdf5/blob/develop"
#Other projects that contribute to HDF5
ALIASES += PRJURL="\HDFURL/projects"
ALIASES += PRJURL="\HDFURL/archive/support/projects"
ALIASES += HVURL="github.com/HDFGroup/hdfview/blob/master"
ALIASES += PLURL="github.com/HDFGroup/hdf5_plugins/blob/master"
################################################################################
Expand Down Expand Up @@ -257,6 +257,13 @@ ALIASES += callback_note="\attention \Bold{Leaving callback functions:}\n The ca
ALIASES += par_compr_note="\attention If you are planning to use compression with parallel HDF5, ensure that calls to H5Dwrite() occur in collective mode. In other words, all MPI ranks (in the relevant communicator) call H5Dwrite() and pass a dataset transfer property list with the MPI-IO collective option property set to #H5FD_MPIO_COLLECTIVE_IO.\n Note that data transformations are currently \Bold{not} supported when writing to datasets in parallel and with compression enabled."
ALIASES += sa_metadata_ops="\sa \li H5Pget_all_coll_metadata_ops() \li H5Pget_coll_metadata_write() \li H5Pset_all_coll_metadata_ops() \li H5Pset_coll_metadata_write() \li \ref maybe_metadata_reads"

################################################################################
# Specifications
################################################################################

ALIASES += ref_spec_fileformat="\ref FMT3"
ALIASES += ref_spec_fileformat_btrees_v1="\ref subsubsec_fmt3_infra_btrees_v1"

################################################################################
# References
################################################################################
Expand Down
Loading
Loading