Skip to content
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
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

As part of the [scikit-learn-contrib](https://github.com/scikit-learn-contrib) GitHub organization, we adopt the scikit-learn [code of conduct](https://github.com/scikit-learn/scikit-learn/blob/main/CODE_OF_CONDUCT.md).
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
'sphinx_gallery.gen_gallery',
'sphinx.ext.autosectionlabel',
'sphinx_copybutton',
'sphinx_design',
'numpydoc',
'sphinx.ext.linkcode',
'gh_substitutions',
Expand Down
29 changes: 22 additions & 7 deletions doc/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ Your contribution is welcome and highly valuable. It can be
You can submit a `pull request <https://github.com/scikit-learn-contrib/skglm/pulls>`_
to integrate your changes and we will reach out to you shortly.


As part of the `scikit-learn-contrib <https://github.com/scikit-learn-contrib>`_ GitHub organization, we adopt the scikit-learn `code of conduct <https://github.com/scikit-learn/scikit-learn/blob/main/CODE_OF_CONDUCT.md>`_.

.. note::

- If you are willing to contribute with code to ``skglm``, check the section below to learn how to install
the development version of ``skglm``
If you are willing to contribute with code to ``skglm``, check the section below to learn how to install the development version of ``skglm``



Expand All @@ -51,10 +53,23 @@ contribute with code or documentation.
$ pip install -e .


3. To run the gallery of examples and build the documentation, run
3. To build the documentation, run

.. code-block:: shell

$ cd doc
$ pip install .[doc]
$ make html
.. tab-set::

.. tab-item:: with the gallery of example

.. code-block:: shell

$ cd doc
$ pip install .[doc]
$ make html

.. tab-item:: without the gallery of example

.. code-block:: shell

$ cd doc
$ pip install .[doc]
$ make html-noplot
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ doc = [
"sphinx-bootstrap-theme",
"sphinx_copybutton",
"sphinx-gallery",
"sphinx-design",
"pytest",
"furo",
"lifelines",
Expand Down