Skip to content

Commit de21e4d

Browse files
committed
Splits up documentations page into "algo+examples" and rest
1 parent 0a14a9e commit de21e4d

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

docs/source/docs.rst renamed to docs/source/algorithms_and_examples.rst

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The following learners are implemented:
2222
estimate the mean value of the function at each point,
2323
- `~adaptive.IntegratorLearner`, for
2424
when you want to intergrate a 1D function ``f: ℝ → ℝ``.
25+
- ``~adaptive.BalancingLearner``, for when you want to run several learners at once,
26+
selecting the “best” one each time you get more points.
2527

2628
Meta-learners (to be used with other learners):
2729

@@ -33,6 +35,8 @@ In addition to the learners, ``adaptive`` also provides primitives for
3335
running the sampling across several cores and even several machines,
3436
with built-in support for
3537
`concurrent.futures <https://docs.python.org/3/library/concurrent.futures.html>`_,
38+
`mpi4py <https://mpi4py.readthedocs.io/en/stable/mpi4py.futures.html>`_,
39+
`loky <https://loky.readthedocs.io/en/stable/>`_,
3640
`ipyparallel <https://ipyparallel.readthedocs.io/en/latest/>`_ and
3741
`distributed <https://distributed.readthedocs.io/en/latest/>`_.
3842

@@ -168,13 +172,3 @@ on the *Play* :fa:`play` button or move the sliders.
168172
fig
169173

170174
see more in the :ref:`Tutorial Adaptive`.
171-
172-
.. include:: ../../README.rst
173-
:start-after: not-in-documentation-end
174-
:end-before: credits-end
175-
176-
.. mdinclude:: ../../AUTHORS.md
177-
178-
.. include:: ../../README.rst
179-
:start-after: credits-end
180-
:end-before: references-start

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
:maxdepth: 2
1717
:hidden:
1818

19-
docs
19+
algorithms_and_examples
20+
misc
2021
tutorial/tutorial
2122
usage_examples
2223
reference/adaptive

docs/source/misc.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
.. include:: ../../README.rst
3+
:start-after: not-in-documentation-end
4+
:end-before: credits-end
5+
6+
.. mdinclude:: ../../AUTHORS.md
7+
8+
.. include:: ../../README.rst
9+
:start-after: credits-end
10+
:end-before: references-start

0 commit comments

Comments
 (0)