... | ... |
@@ -6,7 +6,7 @@ |
6 | 6 |
================= |
7 | 7 |
|
8 | 8 |
|PyPI| |Conda| |Downloads| |pipeline status| |DOI| |Binder| |Join the |
9 |
-chat at https://gitter.im/python-adaptive/adaptive| |
|
9 |
+chat at https://gitter.im/python-adaptive/adaptive| |Documentation Status| |
|
10 | 10 |
|
11 | 11 |
**Tools for adaptive parallel sampling of mathematical functions.** |
12 | 12 |
|
... | ... |
@@ -17,10 +17,10 @@ just supply a function with its bounds, and it will be evaluated at the |
17 | 17 |
evaluate functions on a computing cluster, live-plot the data as it |
18 | 18 |
returns, and fine-tune the adaptive sampling algorithm. |
19 | 19 |
|
20 |
-Check out the ``adaptive`` example notebook |
|
21 |
-`learner.ipynb <https://github.com/python-adaptive/adaptive/blob/master/learner.ipynb>`_ (or run it `live on |
|
22 |
-Binder <https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb>`_) |
|
23 |
-to see examples of how to use ``adaptive``. |
|
20 |
+Run the ``adaptive`` example notebook `live on |
|
21 |
+Binder <https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb>`_ |
|
22 |
+to see examples of how to use ``adaptive`` or visit the |
|
23 |
+`tutorial on Read the Docs <https://adaptive.readthedocs.io/en/latest/tutorial/tutorial.html>`__. |
|
24 | 24 |
|
25 | 25 |
.. summary-end |
26 | 26 |
|
... | ... |
@@ -152,4 +152,6 @@ request <https://gitlab.kwant-project.org/qt/adaptive/merge_requests>`_. |
152 | 152 |
:target: https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb |
153 | 153 |
.. |Join the chat at https://gitter.im/python-adaptive/adaptive| image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg |
154 | 154 |
:target: https://gitter.im/python-adaptive/adaptive |
155 |
+.. |Documentation Status| image:: https://readthedocs.org/projects/adaptive/badge/?version=latest |
|
156 |
+ :target: https://adaptive.readthedocs.io/en/latest/?badge=latest |
|
155 | 157 |
.. references-end |
... | ... |
@@ -14,6 +14,8 @@ dependencies: |
14 | 14 |
- jupyter_client>=5.2.2 |
15 | 15 |
- ipywidgets |
16 | 16 |
- scikit-optimize |
17 |
+ - nbconvert>=5.4* # because my jupyter-sphinx branch depends on it |
|
17 | 18 |
- pip: |
18 | 19 |
- sphinx_rtd_theme |
19 | 20 |
- git+https://github.com/basnijholt/jupyter-sphinx.git@widgets_execute |
21 |
+ - git+https://github.com/python-adaptive/adaptive.git@master # temporary solution because jupyter-sphinx doesn't use the adaptive from the repo |
... | ... |
@@ -1,11 +1,6 @@ |
1 | 1 |
Tutorial Adaptive |
2 | 2 |
================= |
3 | 3 |
|
4 |
-.. warning:: |
|
5 |
- This documentation is not functional yet! Whenever |
|
6 |
- `this Pull Request <https://github.com/jupyter-widgets/jupyter-sphinx/pull/22/>`__. |
|
7 |
- is done, the documentation will be correctly build. |
|
8 |
- |
|
9 | 4 |
`Adaptive <https://gitlab.kwant-project.org/qt/adaptive-evaluation>`__ |
10 | 5 |
is a package for adaptively sampling functions with support for parallel |
11 | 6 |
evaluation. |