docs: try dpdata online (#552)

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
deepmodeling · Oct 13, 2023 · 5e8f0ba · 5e8f0ba
1 parent 57c5004
commit 5e8f0ba
Show file tree

Hide file tree

Showing 12 changed files with 2,632 additions and 19 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,10 +3,9 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "mambaforge-22.9"
+conda:
+  environment: docs/rtd_environment.yml
 sphinx:
    configuration: docs/conf.py
 formats: all
-python:
-   install:
-   - requirements: docs/requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -49,6 +49,7 @@
     "numpydoc",
     "m2r2",
     "sphinxarg.ext",
+    "jupyterlite_sphinx",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -202,3 +203,7 @@ def setup(app):
     "monty": ("https://guide.materialsvirtuallab.org/monty/", None),
     "h5py": ("https://docs.h5py.org/en/stable/", None),
 }
+
+# jupyterlite
+jupyterlite_contents = "./nb"
+jupyterlite_bind_ipynb_suffix = False
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -0,0 +1,11 @@
+name: dpdata
+channels:
+  - https://repo.mamba.pm/emscripten-forge
+  - https://repo.mamba.pm/conda-forge
+dependencies:
+  - numpy
+  - scipy
+  - monty
+  - wcmatch
+  - pip:
+    - ..
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,6 +11,7 @@ Welcome to dpdata's documentation!
    :caption: Contents:
 
    Overview <self>
+   try_dpdata
    cli
    formats
    drivers