Contributing documentation, notes

HDF5 Library Library Development
1

I’m starting this thread to store some notes on contributing documentation changes to HDF5. Helping with documentation is often something that can be done with by users who may not have extensive programming experience in C.

Prerequisites

  • git
  • cmake
  • doxygen
  • web browser

Quick start

git clone https://github.com/HDFGroup/hdf5.git
cd hdf5
mkdir build
cmake -D HDF5_BUILD_DOC=ON ..
make doxygen
open hdf5lib_docs/html/index.html # alternatively, invoke your web browser directly
2 Likes