DOC - add Whatsnew section (#75)

Co-authored-by: Badr MOUFAD <[email protected]>
Co-authored-by: mathurinm <[email protected]>

Author: 3 people

doc/api.rst

@@ -41,6 +41,8 @@ Penalties
    MCPenalty
    WeightedL1
    WeightedGroupL2
+   SCAD
+   BlockSCAD
 
 
 Datafits

doc/changes/0.1.rst

@@ -0,0 +1,6 @@
+.. _changes_0_1:
+
+Version 0.1 (2022-04-25)
+------------------------
+
+- Initial release (initial commit: 2022-04-20)

doc/changes/0.2.rst

@@ -0,0 +1,18 @@
+.. _changes_0_2:
+
+Version 0.2 (in progress)
+------------------------
+
+- Accelerated block coordinate descent solver :ref:`GroupBCD <skglm.solvers.GroupBCD>` with working sets for problems with group penalties (PR :gh:`29`, :gh:`28`, and :gh:`26`)
+
+- Proximal Newton solver :ref:`ProxNewton <skglm.solvers.ProxNewton>` with working sets for problems with non-quadratic datafits (PR :gh:`51`)
+
+- :ref:`Huber <skglm.datafits.Huber>` datafit (PR :gh:`14`)
+
+- Added :ref:`SCAD <skglm.penalties.SCAD>` and :ref:`BlockSCAD <skglm.penalties.BlockSCAD>` penalties (PR :gh:`12`)
+
+- Fitting intercept for :ref:`Quadratic <skglm.datafits.Quadratic>`, :ref:`Logistic <skglm.datafits.Logistic>` and :ref:`Huber <skglm.datafits.Huber>` datafits (PR :gh:`55`)
+
+- Added :ref:`GramCD <skglm.solvers.GramCD>`, a Gram-based coordinate descent solver for problems with ``n_features`` :math:`\ll` ``n_samples`` (PR :gh:`59`)
+
+- Transform solvers from functions to classes (PR :gh:`63`)

doc/conf.py

@@ -12,7 +12,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-from skglm import __version__ as version
+import os
 import sys
 import warnings
 # import os
@@ -21,6 +21,11 @@
 from numpydoc import numpydoc, docscrape  # noqa
 from doc.github_link import make_linkcode_resolve
 
+from skglm import __version__ as version
+
+curdir = os.path.dirname(__file__)
+sys.path.append(os.path.abspath(os.path.join(curdir, 'sphinxext')))
+
 
 # Mathurin: disable agg warnings in doc
 warnings.filterwarnings("ignore", category=UserWarning,
@@ -50,8 +55,10 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
     'sphinx_gallery.gen_gallery',
+    'sphinx.ext.autosectionlabel',
     'numpydoc',
-    "sphinx.ext.linkcode",
+    'sphinx.ext.linkcode',
+    'gh_substitutions',  # custom ext, see ./sphinxext/gh_substitutions.py
 ]
 
 # generate autosummary even if no references

doc/index.rst

@@ -49,10 +49,10 @@ To check if everything worked fine, you can do::
 and it should not give any error message.
 
 
-API
----
+Release history
+---------------
 
 .. toctree::
     :maxdepth: 1
 
-    api.rst
+    whats_new.rst

doc/sphinxext/gh_substitutions.py

@@ -0,0 +1,21 @@
+"""Provide a convenient way to link to GitHub issues and pull requests.
+
+Adapted from:
+https://doughellmann.com/blog/2010/05/09/defining-custom-roles-in-sphinx/
+"""
+from docutils.nodes import reference
+from docutils.parsers.rst.roles import set_classes
+
+
+def gh_role(name, rawtext, pr_number, lineno, inliner, options={}, content=[]):
+    """Link to a GitHub pull request."""
+    ref = f'https://github.com/scikit-learn-contrib/skglm/pull/{pr_number}'
+    set_classes(options)
+    node = reference(rawtext, '#' + pr_number, refuri=ref, **options)
+    return [node], []
+
+
+def setup(app):
+    """Do setup."""
+    app.add_role('gh', gh_role)
+    return

doc/whats_new.rst

@@ -0,0 +1,11 @@
+.. _whats_new:
+
+What's new
+==========
+
+.. currentmodule:: skglm
+
+.. include:: changes/0.2.rst
+
+.. include:: changes/0.1.rst
+