Skip to content

Files

Latest commit

0d085b5 · Apr 13, 2022

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Apr 13, 2022
Apr 13, 2022
Apr 13, 2022

Documentation

  1. Install Doxygen on your machine:

    • On macOS, using Homebrew
      brew install doxygen
      
    • On Windows, using Chocolatey:
      choco install -y doxygen.install
      
    • On Linux, using your distribution's package manager.
  2. Edit the docs/CMakeLists.txt based on your project specifications (project name, source folders, desired layout, etc.).

  3. Compile the Doxygen project using CMake:

    • Either by compiling the subfolder docs/ directly:
      cd lagrange-project/docs
      mkdir build
      cd build
      cmake ..
      make doc
      
    • Or enabling the FOO_BUILD_DOCUMENTATION CMake option in the parent project:
      cd lagrange-project
      mkdir build
      cd build
      cmake -DFOO_BUILD_DOCUMENTATION=ON ..
      make doc
      
  4. Open the generated html documentation:

    firefox html/index.html