Skip to content

Commit

Permalink
docs: highlight features (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
njzjz committed Apr 14, 2024
1 parent a1b20b2 commit cea0374
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## Additional 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

0 comments on commit cea0374

Please sign in to comment.