Switch to jupyter book

.ci_support/environment-docs.yml

@@ -12,3 +12,4 @@ dependencies:
 - tqdm =4.66.2
 - pyzmq =26.0.2
 - flux-core
+- jupyter-book =1.0.0

.readthedocs.yml

@@ -11,16 +11,20 @@ build:
     python: "mambaforge-22.9"
   jobs:
     pre_build:
+      # Generate the Sphinx configuration for this Jupyter Book so it builds.
       - pip install versioneer[toml]==0.29
       - pip install . --no-deps --no-build-isolation
+      - "cp README.md docs"
+      - "cp notebooks/*.ipynb docs"
+      - "jupyter-book config sphinx docs/"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/source/conf.py
+  builder: html
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: []
 
 # Install pyiron from conda
 conda:
-  environment: .ci_support/environment-docs.yml
+  environment: .ci_support/environment-docs.yml

binder/postBuild

@@ -4,3 +4,9 @@ cp binder/kernel.json /home/jovyan/.local/share/jupyter/kernels/flux
 
 # install pympipool
 pip install . --no-deps --no-build-isolation
+
+# copy notebooks
+mv notebooks/*.ipynb .
+
+# clean up
+rm -rf .ci_support .github binder docs notebooks pympipool pympipool.egg-info tests .coveralls.yml .gitignore .readthedocs.yml LICENSE MANIFEST.in README.md pyproject.toml setup.py build

docs/_config.yml

@@ -0,0 +1,14 @@
+title: pympipool
+author: Jan Janssen
+logo: images/pyiron-logo.png
+
+execute:
+  execute_notebooks           : off
+
+repository:
+    url                       : https://github.com/pyiron/pympipool
+    path_to_book              : ""
+
+launch_buttons:
+  notebook_interface          : jupyterlab
+  binderhub_url               : https://mybinder.org

docs/_toc.yml

@@ -0,0 +1,6 @@
+format: jb-book
+root: README
+chapters:
+- file: installation.md
+- file: examples.ipynb
+- file: development.md