From 9eae2f2957e7172517788970d8c360165e67c80a Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Sun, 14 Apr 2024 06:03:14 -0400 Subject: [PATCH] docs: highlight features --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9f517b3..78999ea 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,9 @@ Set `make_anchor=True` when calling `gendoc` function and use standard ref synta The id is the same as the argument path. Variant types would be in square brackets. Please refer to test files for detailed usage. + +## Features + +- [PEP 484](https://peps.python.org/pep-0484/) type annotations +- Native integration with [Sphinx](https://github.com/sphinx-doc/sphinx), [DP-GUI](https://github.com/deepmodeling/dpgui), and [Jupyter Notebook](https://jupyter.org/) +- JSON encoder for `Argument` and `Variant` classes