From a9f1446a4b2aae339b365b0f5dc8ab8ff261805b Mon Sep 17 00:00:00 2001 From: Marc Toussaint Date: Thu, 28 Sep 2023 20:03:17 +0200 Subject: [PATCH] docu notebooks via rai-python submodule --- .gitmodules | 3 + docs/Makefile | 2 +- docs/genindex.html | 8 +- docs/getting_started.html | 16 +- docs/index.html | 58 +- docs/notebooks.html | 166 ++++ docs/notebooks/1a-configurations.html | 18 +- docs/notebooks/1b-botop.html | 14 +- docs/notebooks/1c-komo.html | 14 +- docs/notebooks/1d-real.html | 315 +------- docs/notebooks/1d-real.ipynb | 308 +------ docs/notebooks/botop2-realRobotStarters.html | 314 -------- docs/notebooks/botop2-realRobotStarters.ipynb | 248 ------ docs/notebooks/botop3-vision-toBeMerged.html | 400 --------- docs/notebooks/botop3-vision.html | 51 +- docs/notebooks/botop4-examples.html | 47 +- docs/notebooks/core2-features.html | 31 +- docs/notebooks/core3-configurations.html | 35 +- docs/notebooks/komo1-IK-toBeMerged.html | 373 --------- docs/notebooks/komo1-IK-toBeMerged.ipynb | 353 -------- .../komo2-PathOptimization-toBeMerged.html | 221 ----- .../komo2-PathOptimization-toBeMerged.ipynb | 148 ---- docs/notebooks/komo2-PathOptimization.html | 43 +- docs/notebooks/komo3-switches-skeletons.html | 51 +- docs/notebooks/notebooks.html | 170 ---- docs/notebooks/opt1-basics.html | 43 +- docs/notebooks/script5-PathFind.html | 39 +- docs/notebooks/sim1-physics.html | 43 +- docs/old/_Array.html | 8 +- docs/old/_Configuration.html | 8 +- docs/old/_ConfigurationFiles.html | 8 +- docs/old/_Graph.html | 8 +- docs/old/_Simulation.html | 8 +- docs/old/komo.html | 8 +- docs/old/old.html | 8 +- docs/old/simlab.html | 8 +- docs/old/simlab1.html | 8 +- docs/old/simlab2.html | 8 +- docs/old/simlab3.html | 8 +- docs/old/simlab4.html | 8 +- docs/old/simlab5.html | 8 +- docs/old/skeleton.html | 8 +- docs/py-modindex.html | 8 +- docs/rai.html | 8 +- docs/script/script.html | 12 +- docs/search.html | 8 +- docs/searchindex.js | 2 +- docs/source/conf.py | 2 +- docs/source/getting_started.md | 4 +- docs/source/index.rst | 35 +- docs/source/notebooks | 1 + docs/source/notebooks.rst | 35 + docs/source/notebooks/1a-configurations.ipynb | 536 ------------- docs/source/notebooks/1b-botop.ipynb | 483 ----------- docs/source/notebooks/1c-komo.ipynb | 736 ----------------- docs/source/notebooks/1d-real.ipynb | 619 -------------- .../notebooks/botop2-realRobotStarters.ipynb | 248 ------ .../notebooks/botop3-vision-toBeMerged.ipynb | 225 ------ docs/source/notebooks/botop3-vision.ipynb | 267 ------ docs/source/notebooks/botop4-examples.ipynb | 629 --------------- docs/source/notebooks/core2-features.ipynb | 414 ---------- .../notebooks/core3-configurations.ipynb | 757 ------------------ .../notebooks/komo1-IK-toBeMerged.ipynb | 353 -------- .../komo2-PathOptimization-toBeMerged.ipynb | 148 ---- .../notebooks/komo2-PathOptimization.ipynb | 203 ----- .../notebooks/komo3-switches-skeletons.ipynb | 316 -------- docs/source/notebooks/notebooks.rst | 31 - docs/source/notebooks/opt1-basics.ipynb | 139 ---- docs/source/notebooks/script5-PathFind.ipynb | 227 ------ docs/source/notebooks/sim1-physics.ipynb | 141 ---- rai-python | 1 + 71 files changed, 621 insertions(+), 9611 deletions(-) create mode 100644 docs/notebooks.html delete mode 100644 docs/notebooks/botop2-realRobotStarters.html delete mode 100644 docs/notebooks/botop2-realRobotStarters.ipynb delete mode 100644 docs/notebooks/botop3-vision-toBeMerged.html delete mode 100644 docs/notebooks/komo1-IK-toBeMerged.html delete mode 100644 docs/notebooks/komo1-IK-toBeMerged.ipynb delete mode 100644 docs/notebooks/komo2-PathOptimization-toBeMerged.html delete mode 100644 docs/notebooks/komo2-PathOptimization-toBeMerged.ipynb delete mode 100644 docs/notebooks/notebooks.html create mode 120000 docs/source/notebooks create mode 100644 docs/source/notebooks.rst delete mode 100644 docs/source/notebooks/1a-configurations.ipynb delete mode 100644 docs/source/notebooks/1b-botop.ipynb delete mode 100644 docs/source/notebooks/1c-komo.ipynb delete mode 100644 docs/source/notebooks/1d-real.ipynb delete mode 100644 docs/source/notebooks/botop2-realRobotStarters.ipynb delete mode 100644 docs/source/notebooks/botop3-vision-toBeMerged.ipynb delete mode 100644 docs/source/notebooks/botop3-vision.ipynb delete mode 100644 docs/source/notebooks/botop4-examples.ipynb delete mode 100644 docs/source/notebooks/core2-features.ipynb delete mode 100644 docs/source/notebooks/core3-configurations.ipynb delete mode 100644 docs/source/notebooks/komo1-IK-toBeMerged.ipynb delete mode 100644 docs/source/notebooks/komo2-PathOptimization-toBeMerged.ipynb delete mode 100644 docs/source/notebooks/komo2-PathOptimization.ipynb delete mode 100644 docs/source/notebooks/komo3-switches-skeletons.ipynb delete mode 100644 docs/source/notebooks/notebooks.rst delete mode 100644 docs/source/notebooks/opt1-basics.ipynb delete mode 100644 docs/source/notebooks/script5-PathFind.ipynb delete mode 100644 docs/source/notebooks/sim1-physics.ipynb create mode 160000 rai-python diff --git a/.gitmodules b/.gitmodules index 72a4b62..fe1fcba 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,3 +4,6 @@ [submodule "rai-robotModels"] path = rai-robotModels url = https://github.com/Jung-Su/rai-robotModels.git +[submodule "rai-python"] + path = rai-python + url = https://github.com/MarcToussaint/rai-python.git diff --git a/docs/Makefile b/docs/Makefile index 4076171..1c44e2d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -16,7 +16,7 @@ help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) clean: - rm -Rf notebooks tut script old *.html _static _sources searchindex.js objects.inv .doctrees/ + rm -Rf notebooks tut script old *.html _static _sources searchindex.js objects.inv _images/ .doctrees/ .PHONY: help Makefile diff --git a/docs/genindex.html b/docs/genindex.html index 24698c1..b4dade9 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -3,7 +3,7 @@ - Index — Robotics Course documentation + Index — Robotics Python Library documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • 2. Tutorials
    • +
  • +
    • +
+
+
+
+
+ +
+

2. Tutorials

+

All tutorials are jupyter notebooks, downloadable from https://github.com/MarcToussaint/rai-python/tree/master/notebooks +(TODO: own github)

+
+

2.1. Basics on Configurations, BotOp & KOMO

+

This round of 4 tutorials builds on each other and gives a first idea what this lib is about.

+
+ +
+
+
+

2.2. In Depth

+

There is no special ordering of the following. Each goes deeper in one particular part of the lib.

+

[These need consolidation, cleaning, and merging with the ‘old material’!]

+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/notebooks/1a-configurations.html b/docs/notebooks/1a-configurations.html index 151083e..da3331d 100644 --- a/docs/notebooks/1a-configurations.html +++ b/docs/notebooks/1a-configurations.html @@ -4,7 +4,7 @@ - 2.1.1. Configurations — Robotics Course documentation + 2.1.1. Configurations — Robotics Python Library documentation @@ -24,7 +24,7 @@ - + @@ -36,7 +36,7 @@ - Robotics Course + Robotics Python Library
@@ -49,8 +49,8 @@

Contents:

  • 1. Getting Started
    • -
  • 2. Tutorials
      -
    • 2.1. 1st Round: Basics on Configurations, BotOp & KOMO
        +
      • 2. Tutorials
          +
        • 2.1. 1st Round: Basics on Configurations, BotOp & KOMO
        • 3. Lecture Script
          • @@ -78,7 +78,7 @@
          @@ -86,7 +86,7 @@