Rename master into main (#38)

* master to main

* rdev

* setup

* ci

* req

* opy

* rst

* rst

* rst

* rst

* setup

* setup

---------

Co-authored-by: Xavier Dupre <[email protected]>

Author: sdpython

.github/workflows/documentation.yml

@@ -33,17 +33,23 @@ jobs:
         with:
           python-version: '3.11'
 
+      - name: Install pandoc
+        run: sudo apt-get install -y pandoc
+
       - name: Install requirements
         run: python -m pip install -r requirements.txt
 
-      - name: Install requirements-dev.txt
-        run: python -m pip install -r requirements-dev.txt
-
-      - name: Install
-        run: python -m pip install -e .
+      #- name: Install
+      #  run: python -m pip install -e .
+      - name: Copy license
+        run: cp LICENSE* ./_doc/sphinxdoc/source
+      - name: Copy readme
+        run: cp README* ./_doc/sphinxdoc/source
 
+      #- name: Documentation
+      #  run: python -m sphinx ./_doc/sphinxdoc/source ./dist/html
       - name: Documentation
-        run: python -m sphinx ./_doc ./dist/html
+        run: python setup.py build_sphinx
 
       - uses: actions/upload-artifact@v3
         with:

README.rst

@@ -1,14 +1,14 @@
 
-.. image:: https://travis-ci.com/sdpython/mlstatpy.svg?branch=master
+.. image:: https://travis-ci.com/sdpython/mlstatpy.svg?branch=main
     :target: https://app.travis-ci.com/github/sdpython/mlstatpy
     :alt: Build status
 
 .. image:: https://ci.appveyor.com/api/projects/status/5env33qptorgshaq?svg=true
     :target: https://ci.appveyor.com/project/sdpython/mlstatpy
     :alt: Build Status Windows
 
-.. image:: https://circleci.com/gh/sdpython/mlstatpy/tree/master.svg?style=svg
-    :target: https://circleci.com/gh/sdpython/mlstatpy/tree/master
+.. image:: https://circleci.com/gh/sdpython/mlstatpy/tree/main.svg?style=svg
+    :target: https://circleci.com/gh/sdpython/mlstatpy/tree/main
 
 .. image:: https://badge.fury.io/py/mlstatpy.svg
     :target: https://pypi.org/project/mlstatpy/
@@ -17,8 +17,8 @@
     :alt: MIT License
     :target: http://opensource.org/licenses/MIT
 
-.. image:: https://codecov.io/github/sdpython/mlstatpy/coverage.svg?branch=master
-    :target: https://codecov.io/github/sdpython/mlstatpy?branch=master
+.. image:: https://codecov.io/github/sdpython/mlstatpy/coverage.svg?branch=main
+    :target: https://codecov.io/github/sdpython/mlstatpy?branch=main
 
 .. image:: http://img.shields.io/github/issues/sdpython/mlstatpy.png
     :alt: GitHub Issues

_doc/sphinxdoc/source/c_algo/gest.rst

@@ -53,7 +53,7 @@ Explications
 ============
 
 La présentation
-`Détection des images dans les images digitales <https://github.com/sdpython/mlstatpy/blob/master/_todo/segment_detection/presentation.pdf>`_
+`Détection des images dans les images digitales <https://github.com/sdpython/mlstatpy/blob/main/_todo/segment_detection/presentation.pdf>`_
 détaille le principe de l'algorithme. L'idée de l'algorithme est assez
 proche de la `transformée de Hough <https://fr.wikipedia.org/wiki/Transform%C3%A9e_de_Hough>`_.
 Celle-ci est implémentée dans le module

_doc/sphinxdoc/source/conf.py

@@ -120,6 +120,7 @@
         "PiecewiseTreeRegressor": "http://www.xavierdupre.fr/app/mlinsights/helpsphinx/mlinsights/mlmodel/"
         "piecewise_tree_regression.html#mlinsights.mlmodel.piecewise_tree_regression.PiecewiseTreeRegressor",
         "Predictable t-SNE": "http://www.xavierdupre.fr/app/mlinsights/helpsphinx/notebooks/predictable_tsne.html",
+        "QuantileLinearRegression": "http://www.xavierdupre.fr/app/mlinsights/helpsphinx/mlinsights/mlmodel/quantile_regression.html#mlinsights.mlmodel.quantile_regression.QuantileLinearRegression",
         "R-tree": "https://en.wikipedia.org/wiki/R-tree",
         "R* tree": "https://en.wikipedia.org/wiki/R*_tree",
         "Regression with confidence interval": "http://www.xavierdupre.fr/app/mlinsights/helpsphinx/notebooks/regression_confidence_interval.html",

_doc/sphinxdoc/source/index.rst

@@ -38,16 +38,16 @@ Xavier Dupré
 
 .. only:: html
 
-    .. image:: https://travis-ci.com/sdpython/mlstatpy.svg?branch=master
+    .. image:: https://travis-ci.com/sdpython/mlstatpy.svg?branch=main
         :target: https://app.travis-ci.com/github/sdpython/mlstatpy
         :alt: Build status
 
     .. image:: https://ci.appveyor.com/api/projects/status/5env33qptorgshaq?svg=true
         :target: https://ci.appveyor.com/project/sdpython/mlstatpy
         :alt: Build Status Windows
 
-    .. image:: https://circleci.com/gh/sdpython/mlstatpy/tree/master.svg?style=svg
-        :target: https://circleci.com/gh/sdpython/mlstatpy/tree/master
+    .. image:: https://circleci.com/gh/sdpython/mlstatpy/tree/main.svg?style=svg
+        :target: https://circleci.com/gh/sdpython/mlstatpy/tree/main
 
     .. image:: https://badge.fury.io/py/mlstatpy.svg
         :target: https://pypi.org/project/mlstatpy/
@@ -56,8 +56,8 @@ Xavier Dupré
         :alt: MIT License
         :target: http://opensource.org/licenses/MIT
 
-    .. image:: https://codecov.io/github/sdpython/mlstatpy/coverage.svg?branch=master
-        :target: https://codecov.io/github/sdpython/mlstatpy?branch=master
+    .. image:: https://codecov.io/github/sdpython/mlstatpy/coverage.svg?branch=main
+        :target: https://codecov.io/github/sdpython/mlstatpy?branch=main
 
     .. image:: http://img.shields.io/github/issues/sdpython/mlstatpy.png
         :alt: GitHub Issues

requirements.txt

@@ -40,7 +40,7 @@ snakeviz
 scikit-learn>=1.1
 git+https://github.com/onnx/sklearn-onnx.git
 sphinx
-sphinx-bootstrap-theme
+sphinx_gallery 
 sphinxcontrib.imagesvg
 stack_data
 statsmodels

setup.py

@@ -3,6 +3,7 @@
 import os
 from setuptools import find_packages, setup
 from pyquicksetup import read_version, read_readme, default_cmdclass
+from pyquicksetup.pyquick import _SetupCommand
 
 #########
 # settings
@@ -37,6 +38,38 @@
 package_data = {}
 
 
+class SetupCommandSphinx(_SetupCommand):
+    description = "Builds documentation."
+
+    user_options = [
+        ("layout=", None, "format generation, default is html,rst."),
+        (
+            "nbformats=",
+            None,
+            "format generation, default is ipynb,slides,html,python,rst,github",
+        ),
+    ]
+
+    def initialize_options(self):
+        self.layout = "html,rst"
+        self.nbformats = "ipynb,html,python,rst,github"
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        from pyquickhelper.pycode import process_standard_options_for_setup
+
+        parameters = self.get_parameters()
+        parameters["argv"] = ["build_sphinx"]
+        parameters["layout"] = self.layout.split(",")
+        parameters["nbformats"] = self.nbformats.split(",")
+        process_standard_options_for_setup(**parameters)
+
+
+defcla = default_cmdclass().copy()
+defcla["build_sphinx"] = SetupCommandSphinx
+
 setup(
     name=project_var_name,
     version=read_version(__file__, project_var_name),
@@ -47,7 +80,7 @@
     download_url=f"https://github.com/sdpython/{project_var_name}/",
     description=DESCRIPTION,
     long_description=read_readme(__file__),
-    cmdclass=default_cmdclass(),
+    cmdclass=defcla,
     keywords=KEYWORDS,
     classifiers=CLASSIFIERS,
     packages=packages,