From ed2f88520affedbebe7b4f5ca8a514397eeb3b80 Mon Sep 17 00:00:00 2001
From: Bas Nijholt <basnijholt@gmail.com>
Date: Thu, 18 Oct 2018 13:46:58 +0200
Subject: [PATCH] small documentation improvements
---
README.rst | 12 +++++++-----
docs/environment.yml | 2 ++
docs/source/_templates/layout.html | 6 +++---
docs/source/tutorial/tutorial.rst | 5 -----
4 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/README.rst b/README.rst
index 303dbb57..ae59c018 100644
--- a/README.rst
+++ b/README.rst
@@ -6,7 +6,7 @@
=================
|PyPI| |Conda| |Downloads| |pipeline status| |DOI| |Binder| |Join the
-chat at https://gitter.im/python-adaptive/adaptive|
+chat at https://gitter.im/python-adaptive/adaptive| |Documentation Status|
**Tools for adaptive parallel sampling of mathematical functions.**
@@ -17,10 +17,10 @@ just supply a function with its bounds, and it will be evaluated at the
evaluate functions on a computing cluster, live-plot the data as it
returns, and fine-tune the adaptive sampling algorithm.
-Check out the ``adaptive`` example notebook
-`learner.ipynb <https://github.com/python-adaptive/adaptive/blob/master/learner.ipynb>`_ (or run it `live on
-Binder <https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb>`_)
-to see examples of how to use ``adaptive``.
+Run the ``adaptive`` example notebook `live on
+Binder <https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb>`_
+to see examples of how to use ``adaptive`` or visit the
+`tutorial on Read the Docs <https://adaptive.readthedocs.io/en/latest/tutorial/tutorial.html>`__.
.. summary-end
@@ -152,4 +152,6 @@ request <https://gitlab.kwant-project.org/qt/adaptive/merge_requests>`_.
:target: https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb
.. |Join the chat at https://gitter.im/python-adaptive/adaptive| image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg
:target: https://gitter.im/python-adaptive/adaptive
+.. |Documentation Status| image:: https://readthedocs.org/projects/adaptive/badge/?version=latest
+ :target: https://adaptive.readthedocs.io/en/latest/?badge=latest
.. references-end
diff --git a/docs/environment.yml b/docs/environment.yml
index 22f54bae..5283e513 100644
--- a/docs/environment.yml
+++ b/docs/environment.yml
@@ -14,6 +14,8 @@ dependencies:
- jupyter_client>=5.2.2
- ipywidgets
- scikit-optimize
+ - nbconvert>=5.4* # because my jupyter-sphinx branch depends on it
- pip:
- sphinx_rtd_theme
- git+https://github.com/basnijholt/jupyter-sphinx.git@widgets_execute
+ - git+https://github.com/python-adaptive/adaptive.git@master # temporary solution because jupyter-sphinx doesn't use the adaptive from the repo
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
index ea11c6f9..918958d7 100644
--- a/docs/source/_templates/layout.html
+++ b/docs/source/_templates/layout.html
@@ -1,6 +1,6 @@
{% extends "!layout.html" %}
{% block extrahead %}
- {%- for scriptfile in holoviews_js_files %}
- {{ js_tag(scriptfile) }}
- {%- endfor %}
+ {%- for scriptfile in holoviews_js_files %}
+ {{ js_tag(scriptfile) }}
+ {%- endfor %}
{% endblock %}
diff --git a/docs/source/tutorial/tutorial.rst b/docs/source/tutorial/tutorial.rst
index 8f3e1cfb..2afd0011 100644
--- a/docs/source/tutorial/tutorial.rst
+++ b/docs/source/tutorial/tutorial.rst
@@ -1,11 +1,6 @@
Tutorial Adaptive
=================
-.. warning::
- This documentation is not functional yet! Whenever
- `this Pull Request <https://github.com/jupyter-widgets/jupyter-sphinx/pull/22/>`__.
- is done, the documentation will be correctly build.
-
`Adaptive <https://gitlab.kwant-project.org/qt/adaptive-evaluation>`__
is a package for adaptively sampling functions with support for parallel
evaluation.
--
GitLab