mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Scot Breitenfeld
05676d1abe
* Consolidate documentation under doc/ directory
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
* Add HDF5_DOCS_DIR variable for doc/ root path
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.
37 lines
765 B
Plaintext
37 lines
765 B
Plaintext
/** \page TN Technical Notes
|
|
|
|
Navigate back: \ref index "Main"
|
|
<hr>
|
|
|
|
\li \ref api-compat-macros
|
|
\li \ref APPDBG
|
|
\li \ref FMTDISC
|
|
\li \ref BRANCHEXPL
|
|
\li \ref CODECONV
|
|
\li \ref CompTS
|
|
\li \ref sec_file_image
|
|
\li \ref subsubsec_dataset_transfer_filter
|
|
\li \ref FileLock
|
|
\li \ref InitShut
|
|
\li \ref IOFLOW
|
|
\li \ref improve_compressed_perf
|
|
\li \ref collective_metadata_io
|
|
\li \ref ParCompr
|
|
\li \ref TNMDC
|
|
\li \ref thread-safe-lib
|
|
\li \ref SWMRTN
|
|
\li \ref ThrdSafe
|
|
\li \ref VDSTN
|
|
\li \ref RELVERSION
|
|
\li \ref UNICODE
|
|
\li \ref VFLTN
|
|
\li <a href="https://github.com/HDFGroup/arch-doc/blob/main/An_Overview_of_the_HDF5_Library_Architecture.v2.pdf">HDF5 Library Architecture Overview</a>
|
|
\li \ref VOL_Connector
|
|
\li \ref CMakeVols
|
|
|
|
<hr>
|
|
Navigate back: \ref index "Main"
|
|
|
|
*/
|
|
|