Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring documentation api #77

Merged
merged 2 commits into from
Nov 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions _doc/api/classique.rst

This file was deleted.

27 changes: 0 additions & 27 deletions _doc/api/datasets.rst

This file was deleted.

9 changes: 9 additions & 0 deletions _doc/api/datasets/data/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

teachpyx.datasets.data
======================



.. automodule:: teachpyx.datasets.data
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/datasets/data_helper.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.datasets.data_helper
=============================

.. automodule:: teachpyx.datasets.data_helper
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/datasets/documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.datasets.documentation
===============================

.. automodule:: teachpyx.datasets.documentation
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/datasets/enedis.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.datasets.enedis
========================

.. automodule:: teachpyx.datasets.enedis
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/datasets/gpd_helper.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.datasets.gpd_helper
============================

.. automodule:: teachpyx.datasets.gpd_helper
:members:
:no-undoc-members:
28 changes: 28 additions & 0 deletions _doc/api/datasets/index.rst
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions _doc/api/datasets/wines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.datasets.wines
=======================

.. automodule:: teachpyx.datasets.wines
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/examples/classiques.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.examples.classiques
============================

.. automodule:: teachpyx.examples.classiques
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/examples/construction_classique.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.examples.construction_classique
========================================

.. automodule:: teachpyx.examples.construction_classique
:members:
:no-undoc-members:
19 changes: 19 additions & 0 deletions _doc/api/examples/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

teachpyx.examples
=================



.. toctree::
:maxdepth: 1
:caption: modules


classiques
construction_classique
numpysex


.. automodule:: teachpyx.examples
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/examples/numpysex.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.examples.numpysex
==========================

.. automodule:: teachpyx.examples.numpysex
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/ext_test_case.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.ext_test_case
======================

.. automodule:: teachpyx.ext_test_case
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/faq/faq_exception.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.faq.faq_exception
==========================

.. automodule:: teachpyx.faq.faq_exception
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/faq/faq_geo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.faq.faq_geo
====================

.. automodule:: teachpyx.faq.faq_geo
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/faq/faq_numpy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.faq.faq_numpy
======================

.. automodule:: teachpyx.faq.faq_numpy
:members:
:no-undoc-members:
7 changes: 7 additions & 0 deletions _doc/api/faq/faq_python.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

teachpyx.faq.faq_python
=======================

.. automodule:: teachpyx.faq.faq_python
:members:
:no-undoc-members:
20 changes: 20 additions & 0 deletions _doc/api/faq/index.rst
Original file line number Diff line number Diff line change
@@ -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:
27 changes: 0 additions & 27 deletions _doc/api/faqs.rst

This file was deleted.

38 changes: 19 additions & 19 deletions _doc/api/index.rst
Original file line number Diff line number Diff line change
@@ -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:
5 changes: 0 additions & 5 deletions _doc/api/numpysex.rst

This file was deleted.

20 changes: 20 additions & 0 deletions _doc/api/practice/index.rst
Original file line number Diff line number Diff line change
@@ -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:
3 changes: 2 additions & 1 deletion _doc/api/practice/rues_paris.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
============================

teachpyx.practice.rues_paris
============================

.. automodule:: teachpyx.practice.rues_paris
:members:
:no-undoc-members:
3 changes: 2 additions & 1 deletion _doc/api/practice/tsp_bresenham.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
===============================

teachpyx.practice.tsp_bresenham
===============================

.. automodule:: teachpyx.practice.tsp_bresenham
:members:
:no-undoc-members:
3 changes: 2 additions & 1 deletion _doc/api/practice/tsp_kohonen.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
=============================

teachpyx.practice.tsp_kohonen
=============================

.. automodule:: teachpyx.practice.tsp_kohonen
:members:
:no-undoc-members:
3 changes: 2 additions & 1 deletion _doc/api/practice/tsp_kruskal.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
=============================

teachpyx.practice.tsp_kruskal
=============================

.. automodule:: teachpyx.practice.tsp_kruskal
:members:
:no-undoc-members:
Loading
Loading