Skip to content

Latest commit

 

History

History

docs

How to build docs

  1. Install doxygen.

    $ sudo apt-get install doxygen graphviz
  2. Install Python packages below. If you install them on the user's local, you need to include ~/.local/bin to $PATH (to use sphinx-build).

    $ sudo python3 -m pip install -r ./requirements.txt
  3. Create Doxygen documents.

    $ doxygen
  4. Create Sphinx documents.

    $ make html
  5. Done. The HTML files will be on _build/ directory.