Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: try dpdata online #552

Merged
merged 11 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"numpydoc",
"m2r2",
"sphinxarg.ext",
"jupyterlite_sphinx",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -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
11 changes: 11 additions & 0 deletions docs/environment.yml
Original file line number Diff line number Diff line change
@@ -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:
- ..
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Welcome to dpdata's documentation!
:caption: Contents:

Overview <self>
try_dpdata
cli
formats
drivers
Expand Down
Loading
Loading