gradio-app / gradio

Build and share delightful machine learning apps, all in Python. 🌟 Star to support our work!
http://www.gradio.app
Apache License 2.0
33.42k stars 2.53k forks source link

Add custom components auto docs to README.md as well #7237

Closed abidlabs closed 8 months ago

abidlabs commented 8 months ago

When we publish a custom component, we should write the auto-generated documentation to the README.md file as well, not just to the space.py file. As the README.md becomes the default documentation if they publish their component to GitHub, which may often be the case.

For example, I just created a new custom component: HighlightedCode.

Spaces shows the full documentation:

image

But the README.md is quite sparse:

image
abidlabs commented 8 months ago

That's because I forgot to push my changes 😵‍💫

image

Amazing stuff @pngwn @freddyaboulton