Improve documentation

[palmieri]

Improve:

• front end
• documentation
• tutorial

[roym899]

Some code inconsistencies, that should probably be fixed as well (will add more if sth comes to my mind):

• PlannerSettings.h

  • uses randomly enum or string to set variables, should be handled uniformly, for enums it would be good to always have a way to get a string representation
  • mix of json parameters and OMPL globals, it would be better to keep this separated
  • steering_type and steer_functions unclear which is used when

• PlannerSettings.cpp

  • initialized steer function ... printed twice potentially with different steer functions

• Folder structure

  • move submodules in third_party folder?
  • base doesn't contain base only, also environments and some other specific files
  • move all source code into ./src folder?
  • bin folder is a mix of executables and other files (generally unusual that building in ./build generates files outside of the build folder?)
  • there are some notebooks in ./ and some in ./plotting
  • ./plotting should be renamed / split up into ./frontend and ./notebooks maybe?

• namespace naming convention inconsistent (e.g., PlannerSettings and distance_computation)

• Python code

  • split up Python code base and Jupyter notebooks
  • PEP8 formatting and docstrings for all functions

• Misc

  • Moving AI scenarios have to activated with setting a boolean to active, it was a bit confusing that generator: "moving_ai" does not work

[eric-heiden]

I added a GitHub action that updates the Doxygen documentation on the Bench-MR website when a commit is pushed to the master branch of this repository. It can take a while to update on the website because on https://github.com/robot-motion/bench-mr runs another action that builds the website when new code is pushed through this Doxygen action.

[ksatyaki]

This tutorial and the benchmarking framework is absolutely top-class. Maybe #42 is also related to this issue. :-)