Skip to content

Commit

Permalink
Update docs for extension packages
Browse files Browse the repository at this point in the history
  • Loading branch information
mkitti committed Nov 14, 2024
1 parent efafa2c commit 876ee74
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 7 deletions.
17 changes: 11 additions & 6 deletions docs/Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -145,41 +145,46 @@ version = "2.46.2+0"
deps = ["HDF5", "bitshuffle_jll"]
path = "../filters/H5Zbitshuffle"
uuid = "51b4e782-877f-4ccf-958a-27bf628210da"
version = "0.1.3"
version = "0.2.0"

[[deps.H5Zblosc]]
deps = ["Blosc", "HDF5"]
path = "../filters/H5Zblosc"
uuid = "c8ec2601-a99c-407f-b158-e79c03c2f5f7"
version = "0.1.2"
version = "0.2.0"

[[deps.H5Zbzip2]]
deps = ["CodecBzip2", "HDF5"]
path = "../filters/H5Zbzip2"
uuid = "094576f2-1e46-4c84-8e32-c46c042eaaa2"
version = "0.1.2"
version = "0.2.0"

[[deps.H5Zlz4]]
deps = ["CodecLz4", "HDF5"]
path = "../filters/H5Zlz4"
uuid = "eb20ec05-5464-47b5-ba41-098e3c1068a3"
version = "0.1.1"
version = "0.2.0"

[[deps.H5Zzstd]]
deps = ["CodecZstd", "HDF5"]
path = "../filters/H5Zzstd"
uuid = "f6f2d980-1ec6-471c-a70d-0270e22f1103"
version = "0.1.2"
version = "0.2.0"

[[deps.HDF5]]
deps = ["Compat", "HDF5_jll", "Libdl", "MPIPreferences", "Mmap", "Preferences", "Printf", "Random", "Requires", "UUIDs"]
path = ".."
uuid = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f"
version = "0.17.1"
weakdeps = ["MPI"]
weakdeps = ["Blosc", "CodecBzip2", "CodecLz4", "CodecZstd", "MPI", "bitshuffle_jll"]

[deps.HDF5.extensions]
BloscExt = "Blosc"
CodecBzip2Ext = "CodecBzip2"
CodecLz4Ext = "CodecLz4"
CodecZstdExt = "CodecZstd"
MPIExt = "MPI"
bitshuffle_jll_ext = "bitshuffle_jll"

[[deps.HDF5_jll]]
deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "LLVMOpenMP_jll", "LazyArtifacts", "LibCURL_jll", "Libdl", "MPICH_jll", "MPIPreferences", "MPItrampoline_jll", "MicrosoftMPI_jll", "OpenMPI_jll", "OpenSSL_jll", "TOML", "Zlib_jll", "libaec_jll"]
Expand Down
12 changes: 11 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,23 @@ using H5Zblosc
using H5Zbzip2
using H5Zlz4
using H5Zzstd
using H5Zbitshuffle
using MPI # needed to generate docs for parallel HDF5 API

# Load extension packages
const BloscExt = Base.get_extension(HDF5, :BloscExt)
const bitshuffle_jll_ext = Base.get_extension(HDF5, :bitshuffle_jll_ext)
const BloscExt = Base.get_extension(HDF5, :BloscExt)
const CodecBzip2Ext = Base.get_extension(HDF5, :CodecBzip2Ext)
const CodecLz4Ext = Base.get_extension(HDF5, :CodecLz4Ext)
const CodecZstdExt = Base.get_extension(HDF5, :CodecZstdExt)

DocMeta.setdocmeta!(HDF5, :DocTestSetup, :(using HDF5); recursive=true)

makedocs(;
sitename="HDF5.jl",
modules=[HDF5, H5Zblosc, H5Zbzip2, H5Zlz4, H5Zzstd],
modules=[HDF5, H5Zblosc, H5Zbzip2, H5Zlz4, H5Zzstd, H5Zbitshuffle,
bitshuffle_jll_ext, BloscExt, CodecBzip2Ext, CodecLz4Ext, CodecZstdExt],
authors="Mustafa Mohamad <[email protected]> and contributors",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
Expand Down

0 comments on commit 876ee74

Please sign in to comment.