Please follow the following steps to build html files

requirements

  1. python 3.10 (The default python --version should be 3.10)

  2. sphinx (>=4.2)

  3. breathe extension

  4. recommonmark

  5. sphinx_rtd_theme

installation

pip3 install sphinx
pip3 install breathe
pip3 install recommonmark
pip3 install sphinx_rtd_theme
  1. Run parse_bindings.py to generate rst files for classes and enums

  2. Follow README in ../bindings to compile and install bindings

  3. Then run

     make html
    
  4. Copy custom.css and pk_scripts.js into _build/html/_static