Repository: PEtab-dev/petab_select (language: python)

Issue:
Prettify/populate sphinx-doc
https://petab-select.readthedocs.io/en/develop/ still needs some work

- [x] nicer landing page
- [x] petab-select input files #102 
- [x] link to pypesto integration example
- [x] link to other tools supporting petab-select



Discussion / hints:
@dilpath : do you prefer having `File formats` and `Test cases` only on readthedocs, or README+readthedocs?
I would prefer having it on readthedocs only

Fix patch:
diff --git a/README.md b/README.md
index d554c423..15dff1f6 100644
--- a/README.md
+++ b/README.md
@@ -46,38 +46,3 @@ given the forward method and a predecessor model with 2 estimated parameters,
 if there are no models with 3 estimated parameters, but some models with 4
 estimated parameters, then the search may return candidate models with 4
 estimated parameters.
-
-## Test cases
-
-Several test cases are provided, to test the compatibility of a
-PEtab-compatible calibration tool with different PEtab Select features.
-
-The test cases are available in the `test_cases` directory, and are provided in
-the model format.
-
-| Test ID                                      | Criterion | Method           | Model space files | Compressed format | Constraints files | Predecessor (initial) models files |
-|----------------------------------------------|-----------|------------------|-------------------|-------------------|-------------------|------------------------------------|
-| 0001                                         | (all)     | (only one model) | 1                 |                   |                   |                                    |
-| 0002<sup>[1](#test_case_0002)</sup>          | AIC       | forward          | 1                 |                   |                   |                                    |
-| 0003                                         | BIC       | all              | 1                 | Yes               |                   |                                    |
-| 0004                                         | AICc      | backward         | 1                 |                   | 1                 |                                    |
-| 0005                                         | AIC       | forward          | 1                 |                   |                   | 1                                  |
-| 0006                                         | AIC       | forward          | 1                 |                   |                   |                                    |
-| 0007<sup>[2](#test_case_0007_and_0008)</sup> | AIC       | forward          | 1                 |                   |                   |                                    |
-| 0008<sup>[2](#test_case_0007_and_0008)</sup> | AICc      | backward         | 1                 |                   |                   |                                    |
-| 0009<sup>[3](#test_case_0009)</sup>          | AICc      | FAMoS            | 1                 | Yes               |                   | Yes                                |
-
-<a name="test_case_0002">1</a>. Model `M1_0` differs from `M1_1` in three
-parameters, but only 1 additional estimated parameter. The effect of this on
-model selection criteria needs to be clarified. Test case 0006 is a duplicate
-of 0002 that doesn't have this issue.
-
-<a name="test_case_0007_and_0008">2</a>. Noise parameter is removed, noise is
-fixed to `1`.
-
-<a name="test_case_0009">3</a>. This is a computationally expensive problem to
-solve. Developers can try a model selection initialized with the provided
-predecessor model, which is a model start that reproducibly finds the expected
-model. To solve the problem reproducibly <i>ab initio</i>, on the order of 100
-random model starts are required. This test case reproduces the model selection
-problem presented in https://doi.org/10.1016/j.cels.2016.01.002 .
diff --git a/doc/index.rst b/doc/index.rst
index 0e785a82..62c081a6 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -11,6 +11,7 @@ Welcome to petab-select's documentation!
    :caption: Contents:
 
    examples
+   Test Suite <test_suite>
    api
    problem_definition
 


Test patch:
diff --git a/doc/test_suite.rst b/doc/test_suite.rst
new file mode 100644
index 00000000..9b9aa443
--- /dev/null
+++ b/doc/test_suite.rst
@@ -0,0 +1,88 @@
+Model selection test suite
+==========================
+
+Several test cases are provided, to test the compatibility of a
+PEtab-compatible calibration tool with different PEtab Select features.
+
+The test cases are available in the ``test_cases`` directory, and are provided in
+the model format.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Test ID
+     - Criterion
+     - Method
+     - Model space files
+     - Compressed format
+     - Constraints files
+     - Predecessor (initial) models files
+   * - 0001
+     - (all)
+     - (only one model)
+     - 1
+     -
+     -
+     -
+   * - 0002 [#f1]_
+     - AIC
+     - forward
+     - 1
+     -
+     -
+     -
+   * - 0003
+     - BIC
+     - all
+     - 1
+     - Yes
+     -
+     -
+   * - 0004
+     - AICc
+     - backward
+     - 1
+     -
+     - 1
+     -
+   * - 0005
+     - AIC
+     - forward
+     - 1
+     -
+     -
+     - 1
+   * - 0006
+     - AIC
+     - forward
+     - 1
+     -
+     -
+     -
+   * - 0007 [#f2]_
+     - AIC
+     - forward
+     - 1
+     -
+     -
+     -
+   * - 0008 [#f2]_
+     - AICc
+     - backward
+     - 1
+     -
+     -
+     -
+   * - 0009 [#f3]_
+     - AICc
+     - FAMoS
+     - 1
+     - Yes
+     -
+     - Yes
+
+.. [#f1] Model ``M1_0`` differs from ``M1_1`` in three parameters, but only 1 additional estimated parameter. The effect of this on model selection criteria needs to be clarified. Test case 0006 is a duplicate of 0002 that doesn't have this issue.
+
+.. [#f2] Noise parameter is removed, noise is fixed to ``1``.
+
+.. [#f3] This is a computationally expensive problem to solve. Developers can try a model selection initialized with the provided predecessor model, which is a model start that reproducibly finds the expected model. To solve the problem reproducibly *ab initio*, on the order of 100 random model starts are required. This test case reproduces the model selection problem presented in https://doi.org/10.1016/j.cels.2016.01.002.