Building the Documentation

Prerequisites

The documentation build relies on Doxygen and Sphinx along with a few extensions.

First, install Doxygen yourself (for example from your distribution’s official repositories, if using Linux). Then install the Python-based requirements with the following command:

pip install -r paimon-cpp/docs/requirements.txt

Building

Note

If you are building the documentation on Windows, not all sections may build properly.

These two steps are mandatory and must be executed in order.

1. Process the C++ API using Doxygen

   cd paimon-cpp/apidoc
   doxygen
   cd -
   

2. Build the complete documentation using Sphinx.

   cd paimon-cpp/docs
   make html
   cd -
   

After these steps are completed, the documentation is rendered in HTML format in paimon-cpp/docs/_build/html. In particular, you can point your browser at paimon-cpp/docs/_build/html/index.html to read the docs and review any changes you made.