From e63854887f93981e9d7970692e947b02f1d07f46 Mon Sep 17 00:00:00 2001 From: Guilhem Saurel <guilhem.saurel@laas.fr> Date: Tue, 10 Apr 2018 18:13:49 +0200 Subject: [PATCH] [Doc] maths/ skel --- doc/Doxyfile.extra.in | 3 +-- doc/maths/dynamics.md | 3 +++ doc/maths/geometry.md | 7 +++++++ doc/maths/intro.md | 3 +++ doc/maths/kinematics.md | 5 +++++ doc/treeview.dox | 6 ++++++ 6 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 doc/maths/dynamics.md create mode 100644 doc/maths/geometry.md create mode 100644 doc/maths/intro.md create mode 100644 doc/maths/kinematics.md diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in index 78c18b7ae..475ea97dd 100644 --- a/doc/Doxyfile.extra.in +++ b/doc/Doxyfile.extra.in @@ -291,8 +291,7 @@ WARN_LOGFILE = @CMAKE_BINARY_DIR@/doc/doxygen.log # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @CMAKE_SOURCE_DIR@/doc/additionalDoc \ - @CMAKE_SOURCE_DIR@/doc \ +INPUT = @CMAKE_SOURCE_DIR@/doc \ @CMAKE_SOURCE_DIR@/src # The RECURSIVE tag can be used to turn specify whether or not subdirectories diff --git a/doc/maths/dynamics.md b/doc/maths/dynamics.md new file mode 100644 index 000000000..25510cacc --- /dev/null +++ b/doc/maths/dynamics.md @@ -0,0 +1,3 @@ +# Dynamics + +## Direct Dynamics diff --git a/doc/maths/geometry.md b/doc/maths/geometry.md new file mode 100644 index 000000000..fe9a88380 --- /dev/null +++ b/doc/maths/geometry.md @@ -0,0 +1,7 @@ +# Geometry + +## Special Euclidian Group + +## Direct Geometry + +## Inverse Geometry diff --git a/doc/maths/intro.md b/doc/maths/intro.md new file mode 100644 index 000000000..c9b3eba2d --- /dev/null +++ b/doc/maths/intro.md @@ -0,0 +1,3 @@ +# Mathematical formulation + +This section describes the mathematical formulation used by Pinocchio, which is the base for Featherstone's algorithms. diff --git a/doc/maths/kinematics.md b/doc/maths/kinematics.md new file mode 100644 index 000000000..b8d4d7d99 --- /dev/null +++ b/doc/maths/kinematics.md @@ -0,0 +1,5 @@ +# Kinematics + +## Direct Kinematics + +## Inverse Kinematics diff --git a/doc/treeview.dox b/doc/treeview.dox index f9767c8d2..352462291 100644 --- a/doc/treeview.dox +++ b/doc/treeview.dox @@ -27,6 +27,12 @@ namespace pinocchio { // Pages/ tutorials organization // + /** \page md_doc_maths_intro Mathematical Formulation + - \subpage md_doc_maths_geometry + - \subpage md_doc_maths_kinematics + - \subpage md_doc_maths_dynamics + */ + /** \page Chapters Chapters - \subpage md_doc_Chapters_creating-models - \subpage md_doc_Chapters_crtp -- GitLab