Consolidate documentation under doc/ directory#6310
Open
brtnfld wants to merge 2 commits intoHDFGroup:developfrom
Open
Consolidate documentation under doc/ directory#6310brtnfld wants to merge 2 commits intoHDFGroup:developfrom
brtnfld wants to merge 2 commits intoHDFGroup:developfrom
Conversation
Move user-facing guides from release_docs/ and doxygen/ into a single doc/ root. release_docs/ now holds only release artifacts (changelogs, history, release process, maintainer info). - git mv release_docs/INSTALL*.md, USING_*.md, README_HPC.md, BuildSystemNotes.md, AutotoolsToCMakeOptions.md, HDF5_Library_2.0.0_Migration_Guide.md → doc/ - git mv doxygen/ → doc/doxygen/ - Update CMakeLists.txt: HDF5_DOXYGEN_DIR and add_subdirectory path - Update CMakeInstallation.cmake: all install paths for moved files - Update bin/make_vers: hardcoded doxygen/ path substitution - Update doc/doxygen/CMakeLists.txt: EXAMPLES_DIRECTORY and comments - Update README.md, CONTRIBUTING.md, SECURITY.md, config/README.md, release_docs/RELEASE_PROCESS.md: links to moved files - Update doxygen .dox files: release_docs/ URLs for moved guides - Rewrite release_docs/README.md for narrowed scope
brtnfld
requested review from
bmribler,
derobins,
fortnern,
glennsong09,
jhendersonHDF,
lrknox,
qkoziol and
vchoi-hdfgroup
as code owners
CMakeLists.txt
Outdated
| set (HDF5_JAVA_LOGGING_NOP_JAR ${HDF5_SOURCE_DIR}/java/lib/ext/slf4j-nop-2.0.16.jar) | ||
| set (HDF5_JAVA_LOGGING_SIMPLE_JAR ${HDF5_SOURCE_DIR}/java/lib/ext/slf4j-simple-2.0.16.jar) | ||
| set (HDF5_DOXYGEN_DIR ${HDF5_SOURCE_DIR}/doxygen) | ||
| set (HDF5_DOXYGEN_DIR ${HDF5_SOURCE_DIR}/doc/doxygen) |
Collaborator
There was a problem hiding this comment.
Seems we should add an HDF5_DOCS_DIR pointing to ${HDF5_SOURCE_DIR}/doc so that files like CMakeInstallation.cmake don't need edited in the future (hopefully not again though). HDF5_DOXYGEN_DIR could be ${HDF5_DOCS_DIR}/doxygen.
Introduce HDF5_DOCS_DIR = \${HDF5_SOURCE_DIR}/doc so that
CMakeInstallation.cmake and future callers reference the doc/
directory symbolically rather than by hardcoded path.
HDF5_DOXYGEN_DIR is now derived from HDF5_DOCS_DIR.
Addresses review comment on PR HDFGroup#6310.
bmribler
approved these changes
Mar 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Move user-facing guides from release_docs/ ,and doxygen/, into a single doc/ root. release_docs/ now holds only release artifacts (changelogs, history, release process, maintainer info).