refactor documentation structure

lagadic · Dec 7, 2023 · 6176f35 · 6176f35
1 parent 65a98c7
commit 6176f35
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 2 deletions.
diff --git a/modules/python/doc/index.rst b/modules/python/doc/index.rst
@@ -11,5 +11,6 @@ Welcome to the ViSP Python binding documentation!
     :glob:
     :maxdepth: 2
 
-    todos.rst
-    conversions.rst
+    rst/coming_from_cpp.rst
+    rst/python_api.rst
+    rst/known_issues.rst
diff --git a/modules/python/doc/rst/coming_from_cpp.rst b/modules/python/doc/rst/coming_from_cpp.rst
@@ -0,0 +1,2 @@
+Differences with the C++
+==============================
diff --git a/modules/python/doc/todos.rst → modules/python/doc/rst/known_issues.rst b/modules/python/doc/todos.rst → modules/python/doc/rst/known_issues.rst
diff --git a/modules/python/doc/rst/python_api.rst b/modules/python/doc/rst/python_api.rst
@@ -0,0 +1,8 @@
+Python tips
+====================
+
+.. toctree::
+    :glob:
+    :maxdepth: 2
+
+    python_api/conversions.rst
diff --git a/modules/python/doc/conversions.rst → ...python/doc/rst/python_api/conversions.rst b/modules/python/doc/conversions.rst → ...python/doc/rst/python_api/conversions.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Differences with the C++
		==============================