mirror/gradio
2
0
Fork 0
mirror of https://github.com/gradio-app/gradio.git synced 2025-01-12 10:34:32 +08:00
Code Issues Packages Projects Releases Wiki Activity
0a2ba5d0b0
gradio/js/paramviewer/CHANGELOG.md
pngwn 0a2ba5d0b0
chore: update versions (#7004) 
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-01-19 00:13:02 -05:00

1.5 KiB
Raw Blame History

@gradio/paramviewer

0.3.0

Highlights

Custom component documentation generator (#7030 3a944ed)

If your custom component has type hints and docstrings for both parameters and return values, you can now automatically generate a documentation page and README.md with no additional effort. Simply run the following command:

gradio cc docs

This will generate a Gradio app that you can upload to spaces providing rich documentation for potential users. The documentation page includes:

  • Installation instructions.
  • A live embedded demo and working code snippet, pulled from your demo app.
  • An API reference for initialising the component, with types, default values and descriptions.
  • An explanation of how the component affects the user's predict function inputs and outputs.
  • Any additional interfaces or classes that are necessary to understand the API reference.
  • Optional links to GitHub, PyPi, and Hugging Face Spaces.

A README will also be generated detailing the same information but in a format that is optimised for viewing on GitHub or PyPi!

Thanks @pngwn!

Features