Skip to content

docs: highlight features #59

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 14, 2024
Merged

docs: highlight features #59

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9eae2f2
docs: highlight features
njzjz Apr 14, 2024
54a6ce6
revise title
njzjz Apr 14, 2024
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
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