Skip to content

Commit 39e49ea

Browse files
xaduprexadupre
authored
Update documentation action (#40)
* Update documentation action * improve doc * conf * remove fLOG * remove MlGridBenchmark * ut * remove @file * doc * fix many warnings * improve documentation * new series of improvments * improvment * tabs * conf * fix warnings * nit
1 parent ca1fb4c commit 39e49ea

132 files changed

Lines changed: 7039 additions & 8425 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/check_urls.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Check URLs
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- uses: actions/checkout@v3
11+
12+
- name: urls-checker-code
13+
uses: urlstechie/urlchecker-action@master
14+
with:
15+
subfolder: mlstatpy
16+
file_types: .md,.py,.rst,.ipynb
17+
print_all: false
18+
timeout: 2
19+
retry_count# : 2
20+
# exclude_urls: https://github, ...
21+
# exclude_patterns: https://github.com/...
22+
force_pass : true
23+
24+
- name: urls-checker-docs
25+
uses: urlstechie/urlchecker-action@master
26+
with:
27+
subfolder: _doc
28+
file_types: .md,.py,.rst,.ipynb
29+
print_all: false
30+
timeout: 2
31+
retry_count# : 2
32+
# exclude_urls: https://github, ...
33+
# exclude_patterns: https://github.com/...
34+
force_pass : true

‎.github/workflows/documentation.yml‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ jobs:
3333
with:
3434
python-version: '3.11'
3535

36+
- uses: tlylt/install-graphviz@v1
37+
3638
- name: Install pandoc
3739
run: sudo apt-get install -y pandoc
3840

@@ -47,13 +49,27 @@ jobs:
4749

4850
- name: Copy license
4951
run: cp LICENSE* ./_doc
50-
- name: Copy readme
51-
run: cp README* ./_doc
5252
- name: Copy changelogs
5353
run: cp CHANGELOGS* ./_doc
5454

5555
- name: Documentation
56-
run: python -m sphinx ./_doc ./dist/html
56+
run: python -m sphinx ./_doc ./dist/html -n -w doc.txt
57+
58+
- name: Summary
59+
run: cat doc.txt
60+
61+
- name: Check for errors and warnings
62+
run: |
63+
if [[ $(grep ERROR doc.txt) ]]; then
64+
echo "Documentation produces errors."
65+
grep ERROR doc.txt
66+
exit 1
67+
fi
68+
if [[ $(grep WARNING doc.txt) ]]; then
69+
echo "Documentation produces warnings."
70+
grep WARNING doc.txt
71+
exit 1
72+
fi
5773
5874
- uses: actions/upload-artifact@v3
5975
with:

‎README.rst‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,6 @@
2424
:alt: GitHub Issues
2525
:target: https://github.com/sdpython/mlstatpy/issues
2626

27-
.. image:: http://www.xavierdupre.fr/app/mlstatpy/helpsphinx/_images/nbcov.png
28-
:target: http://www.xavierdupre.fr/app/mlstatpy/helpsphinx/all_notebooks_coverage.html
29-
:alt: Notebook Coverage
30-
3127
.. _l-README:
3228

3329
mlstatpy: détours mathématiques autour du machine learning

‎_doc/api/data.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,3 @@ Wikipédia
1616
.. autofunction:: mlstatpy.data.wikipedia.download_titles
1717

1818
.. autofunction:: mlstatpy.data.wikipedia.enumerate_titles
19-
20-
.. autofunction:: mlstatpy.data.wikipedia.download_dump

‎_doc/api/graph.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ Distance
1111

1212
.. autoclass:: mlstatpy.graph.graph_distance.GraphDistance
1313
:members: distance_matching_graphs_paths
14+
:noindex:

‎_doc/api/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ API
1111
data
1212
graph
1313
image
14+
modules/index

‎_doc/api/ml.rst‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,34 @@ Matrices
2828
Métriques
2929
+++++++++
3030

31-
.. autoclass:: mlstatpy.ml.ml_grid_benchmark.MlGridBenchMark
32-
3331
.. autoclass:: mlstatpy.ml.roc.ROC
32+
:noindex:
3433

3534
.. autofunction:: mlstatpy.ml.voronoi.voronoi_estimation_from_lr
3635

3736
Plus proches voisins
3837
++++++++++++++++++++
3938

4039
.. autoclass:: mlstatpy.ml.kppv.NuagePoints
40+
:noindex:
4141

4242
.. autoclass:: mlstatpy.ml.kppv_laesa.NuagePointsLaesa
43+
:noindex:
4344

4445
Tree and neural networks
4546
++++++++++++++++++++++++
4647

4748
.. autoclass:: mlstatpy.ml._neural_tree_node.NeuralTreeNode
49+
:noindex:
4850

4951
.. autoclass:: mlstatpy.ml.neural_tree.NeuralTreeNet
52+
:noindex:
5053

5154
.. autoclass:: mlstatpy.ml.neural_tree.BaseNeuralTreeNet
55+
:noindex:
5256

5357
.. autoclass:: mlstatpy.ml.neural_tree.NeuralTreeNetClassifier
58+
:noindex:
5459

5560
.. autoclass:: mlstatpy.ml.neural_tree.NeuralTreeNetRegressor
61+
:noindex:

‎_doc/api/modules/completion.rst‎

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

‎_doc/api/modules/completion_simple.rst‎

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

‎_doc/api/modules/graph_distance.rst‎

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

0 commit comments

Comments
 (0)