tree: 56a6ae57baf360fb9ee872c8106a6f2df62306f8
  1. docs/
  2. build-docs.sh
  3. CNAME
  4. Doxyfile
  5. mkdocs.yml
  6. README.md
mkdocs/README.md

Documentation

The website is built with MkDocs (Material theme) and Doxygen for API docs, hosted at https://cpp.iceberg.apache.org/.

Prerequisites

Build

From the project root:

make install-deps    # Install Python dependencies
make build-api-docs  # Generate API docs with Doxygen
make build-docs      # Build MkDocs site
make all             # Build everything

Local Preview

make serve-docs      # Serve at http://127.0.0.1:8000

Clean

make clean-docs      # Remove generated files