merge

.github/workflows/run_tests.yml

@@ -18,15 +18,15 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - { python-version: 3.10, os: ubuntu-latest, session: "pre-commit" }
-          - { python-version: 3.10, os: ubuntu-latest, session: "safety" }
-          - { python-version: 3.10, os: ubuntu-latest, session: "mypy" }
-          - { python-version: 3.10, os: ubuntu-latest, session: "tests" }
-          - { python-version: 3.10, os: windows-latest, session: "tests" }
-          - { python-version: 3.10, os: macos-latest, session: "tests" }
-          - { python-version: 3.10, os: ubuntu-latest, session: "typeguard" }
-          - { python-version: 3.10, os: ubuntu-latest, session: "xdoctest" }
-          - { python-version: 3.10, os: ubuntu-latest, session: "docs-build" }
+          - { python-version: "3.10", os: ubuntu-latest, session: "pre-commit" }
+          - { python-version: "3.10", os: ubuntu-latest, session: "safety" }
+          - { python-version: "3.10", os: ubuntu-latest, session: "mypy" }
+          - { python-version: "3.10", os: ubuntu-latest, session: "tests" }
+          - { python-version: "3.10", os: windows-latest, session: "tests" }
+          - { python-version: "3.10", os: macos-latest, session: "tests" }
+          - { python-version: "3.10", os: ubuntu-latest, session: "typeguard" }
+          - { python-version: "3.10", os: ubuntu-latest, session: "xdoctest" }
+          - { python-version: "3.10", os: ubuntu-latest, session: "docs-build" }
 
     env:
       NOXSESSION: ${{ matrix.session }}

.readthedocs.yml

@@ -20,8 +20,7 @@ sphinx:
   configuration: docs/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
-formats:
-  - all
+formats: all
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation

docs/API.rst

@@ -0,0 +1,30 @@
+.. module:: drevalpy
+
+.. automodule:: drevalpy
+   :noindex:
+
+API
+===
+
+Import DrEvalPy using
+
+.. code-block:: python
+
+   import drevalpy as dep
+
+..
+   Models module: :code:`models`
+   -------------------------
+
+   .. module:: devalpy.models
+
+   .. currentmodule:: drevalpy
+
+   Available models
+   ~~~~~~~~~~~~~~~~
+
+   .. autosummary::
+      :toctree: api/models
+
+      models.baselines
+      models.BiGDRP

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = drevalpy
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_key_contributors.rst

@@ -0,0 +1,8 @@
+.. sidebar:: Key Contributors
+
+   * `Judith Bernett <https://github.com/JudithBernett>`_: developer, maintainer
+   * `Pascal Iversen <https://github.com/PascalIversen>`_: developer, maintainer
+   * `Mario Picciani <https://github.com/picciama>`_: developer
+   * `Markus List <https://github.com/mlist>`_: advisor and PI of daisybio
+   * `Katharina Baum <https://github.com/kathbaum>`_: advisor and PI of DILiS
+   * `Mathias Wilhelm <https://github.com/mwilhelm42>`_: advisor and PI of wilhelmlab

docs/_static/custom_cookietemple.css

@@ -0,0 +1,45 @@
+@import "basic.css";
+
+.wy-nav-content {
+    max-width: 1200px;
+}
+
+.wy-side-nav-search {
+    background-color: inherit;
+}
+
+table.align-default {
+    text-align: left;
+}
+
+.autosummary th:first-child,
+.autosummary td:first-child {
+    min-width: 250px;
+}
+
+.autosummary th:first-child,
+.autosummary td:first-child {
+    min-width: 400px;
+}
+
+.autosummary th:last-child,
+.autosummary td:last-child {
+    width: 100%;
+}
+
+.fixed-table {
+    margin-left: 0;
+}
+
+.wy-table-responsive table th p,
+.wy-table-responsive table td p {
+    white-space: normal;
+}
+
+.autosummary {
+    margin-left: 0 !important;
+}
+
+.date {
+    font-size: 50%;
+}

docs/_templates/autosummary/base.rst

@@ -0,0 +1,5 @@
+:github_url: {{ fullname | modurl }}
+
+{% extends "!autosummary/base.rst" %}
+
+.. http://www.sphinx-doc.org/en/stable/ext/autosummary.html#customizing-templates

docs/api/models/drevalpy.models.BiGDRP.rst

@@ -0,0 +1,6 @@
+drevalpy.models.BiGDRP
+======================
+
+.. automodule:: drevalpy.models.BiGDRP
+
+

docs/api/models/drevalpy.models.baselines.rst

@@ -0,0 +1,6 @@
+drevalpy.models.baselines
+=========================
+
+.. automodule:: drevalpy.models.baselines
+
+