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.
32 lines
1.3 KiB
Plaintext
32 lines
1.3 KiB
Plaintext
|
|
/** \mainpage notitle
|
|
|
|
This is the documentation set for HDF5.
|
|
It includes specifications and documentation
|
|
of software and tools developed and maintained by
|
|
<a href="https://www.hdfgroup.org/">The HDF Group</a>. It is impractical to document
|
|
the entire HDF5 ecosystem in one place, and you should also consult the documentation
|
|
sets of the many outstanding community projects.
|
|
|
|
For a first contact with HDF5, the best place is to have a look at the \link
|
|
GettingStarted getting started \endlink page that shows you how to write and
|
|
compile your first program with HDF5.
|
|
|
|
The \b main \b documentation is organized by documentation flavor. Most
|
|
technical documentation consists to varying degrees of information related to
|
|
<em>tasks</em>, <em>concepts</em>, or <em>reference</em> material. As its title
|
|
suggests, the \link RM Reference Manual \endlink is 100% reference material,
|
|
while the \link Cookbook \endlink is focused on tasks. The different guide-type
|
|
documents cover a mix of tasks, concepts, and reference, to help a specific
|
|
<em>audience</em> succeed.
|
|
|
|
\ref release_specific_info
|
|
|
|
\par Offline reading
|
|
You can download the hdf5-\<version\>.doxygen.zip file for offline reading from HDF5 <a href="https://github.com/HDFGroup/hdf5/releases">releases</a>.
|
|
|
|
\par ToDo List
|
|
There is plenty of \ref todo unfinished business.
|
|
|
|
*/
|