Skip to content

Commit 731ea77

Browse files
authored
Improves documentation, continue adding content (#33)
* Improve documentation * more * add data * add bjkst * ruff * urls
1 parent a47b134 commit 731ea77

File tree

23 files changed

+7285
-74
lines changed

23 files changed

+7285
-74
lines changed

.github/workflows/check-urls.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,5 @@ jobs:
4343
timeout: 5
4444
retry_count# : 3
4545
exclude_urls: https://www.data.gouv.fr/fr/datasets/r/4acad602-d8b1-4516-bc71-7d5574d5f33e,http://www.xavierdupre.fr/enseignement/complements/,https://www.gutenberg.org/cache/epub/12587/pg12587.txt,https://www.insee.fr/fr/statistiques/fichier/2407910/,https://castor-informatique.fr,https://hal.archives-ouvertes.fr/hal-00990252/document,https://github.com/onnx/models/raw/main/vision/classification/mobilenet/model/mobilenetv2-12.onnx,https://arxiv.org/ftp/arxiv/papers/1510/1510.04863.pdf,https://hal.science/hal-01125940,https://www.data.gouv.fr/fr/datasets/r/63352e38-d353-4b54-bfd1-f1b3ee1cabd7,https://github.com/sdpython/teachpyx/raw/main/_data/examen2021.zip,https://www.enseignement.polytechnique.fr/informatique/INF423/uploads/Main/poly-good.pdf
46-
exclude_patterns: https://www.data.gouv.fr/fr/datasets/r/e3d83ab3-dc52-4c99-abaf-8a38050cc68c,https://github.com/onnx/models/raw/main/vision/classification/mobilenet/model/mobilenetv2-12.onnx,https://www.data.gouv.fr/fr/datasets/r/63352e38-d353-4b54-bfd1-f1b3ee1cabd7,https://github.com/sdpython/teachpyx/raw/main/_data/examen2021.zip
46+
exclude_patterns: https://github.com/sdpython/teachpyx/blob/main/_doc/practice/exams/,https://github.com/sdpython/teachpyx/raw/exos/_data/,https://www.data.gouv.fr/fr/datasets/r/e3d83ab3-dc52-4c99-abaf-8a38050cc68c,https://github.com/onnx/models/raw/main/vision/classification/mobilenet/model/mobilenetv2-12.onnx,https://www.data.gouv.fr/fr/datasets/r/63352e38-d353-4b54-bfd1-f1b3ee1cabd7,https://github.com/sdpython/teachpyx/raw/main/_data/examen2021.zip
4747
# force_pass : true

_data/README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Sources
2+
=======
3+
4+
* `donnees_enquete_2003_television.txt <donnees_enquete_2003_television.txt>`_ :
5+
* `hugo_dernier_jour_condamne.txt <hugo_dernier_jour_condamne.txt>`_ :
6+
`Le Dernier Jour d'un Condamné by Victor Hugo <https://www.gutenberg.org/ebooks/6838>`_
7+
* `examen2021.zip <examen2021.zip>`_ :
8+
* `paris_54000.zip <paris_54000.zip>`_ :
9+
* `donnees_enquete_2003_television.txt <donnees_enquete_2003_television.txt>`_ :

_data/hugo_dernier_jour_condamne.txt

Lines changed: 5364 additions & 0 deletions
Large diffs are not rendered by default.

_doc/api/classique.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
examples.construction_classique
22
===============================
33

4+
teachpyx.examples.classiques
5+
++++++++++++++++++++++++++++
6+
7+
.. automodule:: teachpyx.examples.classiques
8+
:members:
9+
10+
teachpyx.examples.construction_classique
11+
++++++++++++++++++++++++++++++++++++++++
12+
413
.. automodule:: teachpyx.examples.construction_classique
514
:members:

_doc/api/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Code inclus dans cette librairie
22
================================
33

44
.. toctree::
5+
:caption: Constructions classiques
56

67
classique
78
tools
@@ -14,4 +15,5 @@ Code inclus dans cette librairie
1415
.. toctree::
1516
:caption: FAQ
1617

18+
numpysex
1719
faqs

_doc/api/numpysex.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
examples.numpysex
2+
=================
3+
4+
.. automodule:: teachpyx.examples.numpysex
5+
:members:

_doc/api/practice/rues_paris.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ teachpyx.practice.rues_paris
33
============================
44

55
.. automodule:: teachpyx.practice.rues_paris
6+
:members:

_doc/c_data/matrices.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,3 @@ Calcul matriciel
66

77
nb_array
88
nb_numpy
9-

_doc/c_data/nb_array.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1813,7 +1813,7 @@
18131813
"* Combien de marches s'éloigne de plus de 50 de l'origine?\n",
18141814
"* Parmi celles qui le font, quelle est la moyenne des temps de passage (i.e. le premier moment où ces marches dépassent +/-50)?\n",
18151815
"\n",
1816-
"Vous aurez peut-être besoin des fonctions suivantes: [np.abs](http://docs.scipy.org/doc/numpy/reference/generated/numpy.absolute.html), [np.mean](http://docs.scipy.org/doc/numpy/reference/generated/numpy.mean.html), [np.max](http://docs.scipy.org/doc/numpy/reference/generated/numpy.maximum.html), [np.where](http://docs.scipy.org/doc/numpy/reference/generated/numpy.where.html), [np.argmax](http://docs.scipy.org/doc/numpy/reference/generated/numpy.argmax.html), [np.any](http://docs.scipy.org/doc/numpy/reference/generated/numpy.any.html), [np.cumsum](http://docs.scipy.org/doc/numpy/reference/generated/numpy.cumsum.html), [np.random.randint](http://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randint.html)."
1816+
"Vous aurez peut-être besoin des fonctions suivantes: [np.abs](https://numpy.org/doc/stable/reference/generated/numpy.absolute.html), [np.mean](https://numpy.org/doc/stable/reference/generated/numpy.mean.html), [np.max](https://numpy.org/doc/stable/reference/generated/numpy.max.html), [np.where](https://numpy.org/doc/stable/reference/generated/numpy.where.html), [np.argmax](https://numpy.org/doc/stable/reference/generated/numpy.argmax.html), [np.any](https://numpy.org/doc/stable/reference/generated/numpy.any.html), [np.cumsum](https://numpy.org/doc/stable/reference/generated/numpy.cumsum.html), [np.random.randint](https://numpy.org/doc/stable/reference/random/generated/numpy.random.randint.html)."
18171817
]
18181818
},
18191819
{

_doc/i_ex.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
=================
3-
Tous les exemples
4-
=================
2+
=======================
3+
Syntaxes et définitions
4+
=======================
55

66
Définitions
77
===========

0 commit comments

Comments
 (0)