Update README, add Binder badge, always build all notebooks (#257)

* Update README, add Binder badge, always build all notebooks

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>

* Move badges, clarify user guide notebooks location

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>

* Update readme

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>

* Try to only upload coverage from one build

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>

* Try to fix coveralls issue by using parallel in reporting...

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>

* Update changelog

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>

.github/workflows/build.yml

@@ -33,4 +33,14 @@ jobs:
       - name: Upload coverage to Coveralls
         if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: AndreMiras/coveralls-python-action@develop
-
+        with:
+          parallel: true
+
+  coveralls-finish:
+    needs: build-with-pip
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls finished
+      uses: AndreMiras/coveralls-python-action@develop
+      with:
+        parallel-finished: true

README.rst

@@ -1,3 +1,13 @@
+.. Launch binder
+.. image:: https://mybinder.org/badge_logo.svg
+    :target: https://mybinder.org/v2/gh/pyxem/kikuchipy/HEAD
+    :alt: Launch binder
+
+.. Read the Docs
+.. image:: https://readthedocs.org/projects/kikuchipy/badge/?version=latest
+    :target: https://kikuchipy.org/en/latest/
+    :alt: Documentation status
+
 .. GitHub Actions
 .. image:: https://github.com/pyxem/kikuchipy/workflows/build/badge.svg
     :target: https://github.com/pyxem/kikuchipy/actions
@@ -8,18 +18,13 @@
     :target: https://coveralls.io/github/pyxem/kikuchipy?branch=master
     :alt: Coveralls status
 
-.. Read the Docs
-.. image:: https://readthedocs.org/projects/kikuchipy/badge/?version=latest
-    :target: https://kikuchipy.org/en/latest/
-    :alt: Documentation status
-
 .. PyPI version
 .. image:: https://img.shields.io/pypi/v/kikuchipy.svg
     :target: https://pypi.python.org/pypi/kikuchipy
     :alt: PyPI version
 
 .. Total downloads
-.. image:: https://pepy.tech/badge/kikuchipy
+.. image:: https://static.pepy.tech/personalized-badge/kikuchipy?&left_color=grey&right_color=yellow&left_text=downloads
     :target: https://github.com/pyxem/kikuchipy
     :alt: Total downloads
 
@@ -35,34 +40,13 @@ The library builds on the tools for multi-dimensional data analysis provided
 by the HyperSpy library. An effort is made to keep memory usage in check and
 enable scalability by using the Dask library for pattern processing.
 
-The project is in an alpha stage, and there will likely be breaking changes with
-each release.
+The project is in an **alpha** stage, so there will likely be breaking changes
+with each release...
 
 kikuchipy is released under the GPLv3+ license.
 
-User guide
-----------
-Installation instructions, a user guide and the full API reference are available
-from `our webpage <https://kikuchipy.org>`_.
-
-Tutorials and example workflows
--------------------------------
-Jupyter Notebooks that you can work through and modify to perform processing and
-analyses of EBSD patterns are available `here
-<https://github.com/pyxem/kikuchipy-demos>`_. For learning purposes, we
-recommend to use them alongside our user guide.
-
-Contributing
-------------
-Everyone is welcome to contribute. Please read our `contributor guide
-<https://kikuchipy.org/en/latest/contributing.html>`_ to get started!
-
-Code of Conduct
----------------
-kikuchipy has a `Code of Conduct
-<https://kikuchipy.org/en/latest/code_of_conduct.html>`_ that should be honoured
-by everyone who participates in the kikuchipy community.
-
-Cite
-----
-If you find this project useful, please cite the DOI above.
+- User guide: https://kikuchipy.org, or launch Binder, visit ``doc/`` and run
+  the Jupyter Notebooks
+- Contributing: https://kikuchipy.org/en/latest/contributing.html
+- Code of Conduct: https://kikuchipy.org/en/latest/code_of_conduct.html
+- Cite: If you find this project useful, please cite the DOI above.

doc/changelog.rst

@@ -23,6 +23,8 @@ Contributors
 
 Added
 -----
+- Link to Binder in README and in the notebooks for running them in the browser.
+  (`#257 <https://github.com/pyxem/kikuchipy/pull/257>`_)
 - A data module with a small Nickel EBSD data set and master pattern, and a
   larger EBSD data set downloadable via the module. Two dependencies, pooch and
   tqdm, are added along with this module.

doc/conf.py

@@ -116,6 +116,8 @@
     <div class="admonition note">
       This page was generated from
       <a class="reference external" href="https://github.com/pyxem/kikuchipy/blob/{{ env.config.release|e }}/{{ docname|e }}">{{ docname|e }}</a>.
+      Interactive online version:
+      <span style="white-space: nowrap;"><a href="https://mybinder.org/v2/gh/pyxem/kikuchipy/{{ env.config.release|e }}?filepath={{ docname|e }}"><img alt="Binder badge" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>.</span>
       <script>
         if (document.location.host) {
           $(document.currentScript).replaceWith(
@@ -136,6 +138,8 @@
     \textcolor{gray}{The following section was generated from
     \sphinxcode{\sphinxupquote{\strut {{ docname | escape_latex }}}} \dotfill}}
 """
+# https://nbsphinx.readthedocs.io/en/0.8.0/never-execute.html
+nbsphinx_execute = "always"  # auto, always, never
 
 
 def linkcode_resolve(domain, info):