js/paramviewer/CHANGELOG.md

@gradio/paramviewer

0.4.0

Features

• #7109 125a832 - generate docs when running gradio cc build. Thanks @pngwn!

Fixes

• #7130 e7ab406 - Fix ParamViewer css. Thanks @freddyaboulton!

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

• #7069 07d520c - fix versions. Thanks @pngwn!