Kotakku / cpp_robotics

C++ library for robotics
https://kotakku.github.io/cpp_robotics/
Apache License 2.0
26 stars 2 forks source link

build documentation

cpp_robotics

cpp_roboticsはロボティクスのためのC++ライブラリです

機能追加・実装の方針

環境

サードパーティライブラリ

依存関係の環境構築

sudo apt install libeigen3-dev libgtest-dev
pip install numpy matplotlib

ビルド・インストール

mkdir build && cd build
cmake ..
cmake --build .
sudo cmake --install .

exampleをビルドするときは以下

mkdir build && cd build
cmake -DBUILD_EXAMPLES=ON ..
cmake --build .

cpp_roboticsを使用する(ROS2)

vendorパッケージをワークスペースにcloneしてcolcon buildすることで使用できます
https://github.com/Kotakku/cpp_robotics_vendor

cpp_roboticsを使用する(Pure C++ project)

ライブラリはEigen3の様にヘッダファイルのみであるためCMakeLists.txtには一行追加するだけで使用できます

find_package(cpp_robotics REQUIRED)

ドキュメント

ドキュメント生成

doxybook2とmkdocsをインストール後に以下を実行

sh gen_doc.sh
mkdocs build
mkdocs serve