diff --git a/README.md b/README.md index 99be11b..be259ce 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,11 @@ Please refer to test files for detailed usage. - JSON encoder for `Argument` and `Variant` classes - Generate [JSON schema](https://json-schema.org/) from an `Argument`, which can be further integrated with JSON editors such as [Visual Studio Code](https://code.visualstudio.com/) - Load dict values from external JSON/YAML files via the `$ref` key + +## Notebook support + +Install the optional IPython dependency before importing `dargs.notebook`: + +```bash +python -m pip install "dargs[notebook]" +``` diff --git a/pyproject.toml b/pyproject.toml index d63fc50..38289ca 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,6 +28,9 @@ documentation = "https://docs.deepmodeling.com/projects/dargs" repository = "https://github.com/deepmodeling/dargs" [project.optional-dependencies] +notebook = [ + "ipython", +] test = [ "ipython", "jsonschema",