Refactoring documentation api

sdpython · Nov 3, 2024 · d742b07 · d742b07
1 parent c6bf855
commit d742b07
Show file tree

Hide file tree

Showing 44 changed files with 343 additions and 162 deletions.
diff --git a/_doc/api/classique.rst b/_doc/api/classique.rst
diff --git a/_doc/api/datasets.rst b/_doc/api/datasets.rst
diff --git a/_doc/api/datasets/data/index.rst b/_doc/api/datasets/data/index.rst
@@ -0,0 +1,9 @@
+
+teachpyx.datasets.data
+======================
+
+
+
+.. automodule:: teachpyx.datasets.data
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/datasets/data_helper.rst b/_doc/api/datasets/data_helper.rst
@@ -0,0 +1,7 @@
+
+teachpyx.datasets.data_helper
+=============================
+
+.. automodule:: teachpyx.datasets.data_helper
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/datasets/documentation.rst b/_doc/api/datasets/documentation.rst
@@ -0,0 +1,7 @@
+
+teachpyx.datasets.documentation
+===============================
+
+.. automodule:: teachpyx.datasets.documentation
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/datasets/enedis.rst b/_doc/api/datasets/enedis.rst
@@ -0,0 +1,7 @@
+
+teachpyx.datasets.enedis
+========================
+
+.. automodule:: teachpyx.datasets.enedis
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/datasets/gpd_helper.rst b/_doc/api/datasets/gpd_helper.rst
@@ -0,0 +1,7 @@
+
+teachpyx.datasets.gpd_helper
+============================
+
+.. automodule:: teachpyx.datasets.gpd_helper
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/datasets/index.rst b/_doc/api/datasets/index.rst
@@ -0,0 +1,28 @@
+
+teachpyx.datasets
+=================
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: submodules
+
+
+    data/index
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: modules
+
+
+    data_helper
+    documentation
+    enedis
+    gpd_helper
+    wines
+
+
+.. automodule:: teachpyx.datasets
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/datasets/wines.rst b/_doc/api/datasets/wines.rst
@@ -0,0 +1,7 @@
+
+teachpyx.datasets.wines
+=======================
+
+.. automodule:: teachpyx.datasets.wines
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/examples/classiques.rst b/_doc/api/examples/classiques.rst
@@ -0,0 +1,7 @@
+
+teachpyx.examples.classiques
+============================
+
+.. automodule:: teachpyx.examples.classiques
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/examples/construction_classique.rst b/_doc/api/examples/construction_classique.rst
@@ -0,0 +1,7 @@
+
+teachpyx.examples.construction_classique
+========================================
+
+.. automodule:: teachpyx.examples.construction_classique
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/examples/index.rst b/_doc/api/examples/index.rst
@@ -0,0 +1,19 @@
+
+teachpyx.examples
+=================
+
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: modules
+
+
+    classiques
+    construction_classique
+    numpysex
+
+
+.. automodule:: teachpyx.examples
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/examples/numpysex.rst b/_doc/api/examples/numpysex.rst
@@ -0,0 +1,7 @@
+
+teachpyx.examples.numpysex
+==========================
+
+.. automodule:: teachpyx.examples.numpysex
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/ext_test_case.rst b/_doc/api/ext_test_case.rst
@@ -0,0 +1,7 @@
+
+teachpyx.ext_test_case
+======================
+
+.. automodule:: teachpyx.ext_test_case
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/faq/faq_exception.rst b/_doc/api/faq/faq_exception.rst
@@ -0,0 +1,7 @@
+
+teachpyx.faq.faq_exception
+==========================
+
+.. automodule:: teachpyx.faq.faq_exception
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/faq/faq_geo.rst b/_doc/api/faq/faq_geo.rst
@@ -0,0 +1,7 @@
+
+teachpyx.faq.faq_geo
+====================
+
+.. automodule:: teachpyx.faq.faq_geo
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/faq/faq_numpy.rst b/_doc/api/faq/faq_numpy.rst
@@ -0,0 +1,7 @@
+
+teachpyx.faq.faq_numpy
+======================
+
+.. automodule:: teachpyx.faq.faq_numpy
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/faq/faq_python.rst b/_doc/api/faq/faq_python.rst
@@ -0,0 +1,7 @@
+
+teachpyx.faq.faq_python
+=======================
+
+.. automodule:: teachpyx.faq.faq_python
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/faq/index.rst b/_doc/api/faq/index.rst
@@ -0,0 +1,20 @@
+
+teachpyx.faq
+============
+
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: modules
+
+
+    faq_exception
+    faq_geo
+    faq_numpy
+    faq_python
+
+
+.. automodule:: teachpyx.faq
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/faqs.rst b/_doc/api/faqs.rst
diff --git a/_doc/api/index.rst b/_doc/api/index.rst
@@ -1,29 +1,29 @@
-Code inclus dans cette librairie
-================================
 
-.. toctree::
-    :caption: Constructions classiques
+teachpyx
+========
 
-    classique
-    datasets
-    tools
 
 .. toctree::
-    :caption: Fonctions illustrant des solutions
+    :maxdepth: 1
+    :caption: submodules
 
-    practice/rues_paris
-    practice/tsp_bresenham
-    practice/tsp_kohonen
-    practice/tsp_kruskal
 
-.. toctree::
-    :caption: Animations
+    examples/index
+    video/index
+    tools/index
+    faq/index
+    practice/index
+    datasets/index
 
-    video/tsp_kohonen
-    video/tsp_kruskal
 
 .. toctree::
-    :caption: FAQ
+    :maxdepth: 1
+    :caption: modules
+
+
+    ext_test_case
+
 
-    numpysex
-    faqs
+.. automodule:: teachpyx
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/numpysex.rst b/_doc/api/numpysex.rst
diff --git a/_doc/api/practice/index.rst b/_doc/api/practice/index.rst
@@ -0,0 +1,20 @@
+
+teachpyx.practice
+=================
+
+
+
+.. toctree::
+    :maxdepth: 1
+    :caption: modules
+
+
+    rues_paris
+    tsp_bresenham
+    tsp_kohonen
+    tsp_kruskal
+
+
+.. automodule:: teachpyx.practice
+    :members:
+    :no-undoc-members:
diff --git a/_doc/api/practice/rues_paris.rst b/_doc/api/practice/rues_paris.rst
@@ -1,6 +1,7 @@
-============================
+
 teachpyx.practice.rues_paris
 ============================
 
 .. automodule:: teachpyx.practice.rues_paris
     :members:
+    :no-undoc-members:
diff --git a/_doc/api/practice/tsp_bresenham.rst b/_doc/api/practice/tsp_bresenham.rst
@@ -1,6 +1,7 @@
-===============================
+
 teachpyx.practice.tsp_bresenham
 ===============================
 
 .. automodule:: teachpyx.practice.tsp_bresenham
     :members:
+    :no-undoc-members:
diff --git a/_doc/api/practice/tsp_kohonen.rst b/_doc/api/practice/tsp_kohonen.rst
@@ -1,6 +1,7 @@
-=============================
+
 teachpyx.practice.tsp_kohonen
 =============================
 
 .. automodule:: teachpyx.practice.tsp_kohonen
     :members:
+    :no-undoc-members:
diff --git a/_doc/api/practice/tsp_kruskal.rst b/_doc/api/practice/tsp_kruskal.rst
@@ -1,6 +1,7 @@
-=============================
+
 teachpyx.practice.tsp_kruskal
 =============================
 
 .. automodule:: teachpyx.practice.tsp_kruskal
     :members:
+    :no-undoc-members: