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.
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
Improvements to API Docs #7292
Improvements to API Docs #7292
Conversation
🪼 branch checks and previews
|
🦄 change detectedThis Pull Request includes changes to the following packages.
With the following changelog entry.
Maintainers or the PR author can modify the PR title to modify this entry.
|
</div> | ||
<div class="docs-wrap"> | ||
<div class="client-doc"> | ||
<p> | ||
Use the <a | ||
href="https://gradio.app/docs/#python-client" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These links were broken but it was never reported because I don't think anyone realized that they were links in the first place. The styling does not make it very clear its a link.
@@ -183,11 +186,25 @@ | |||
</li> | |||
{/each} | |||
</div> | |||
|
|||
<p class="padded"> | |||
1. Install the client if you don't already have it installed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think explicitly numbering the steps makes it more inviting to users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fixes @abidlabs lgtm, made one comment
text-decoration: underline; | ||
} | ||
|
||
p.padded { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The font sizes are really off:
The text looks really small. and the code snippets for the libraries are too large with too much padding on the bottom. it's weird.
I suggest adding:
p {
font-size: var(--text-lg);
}
and modifying the .library css to be
.library {
border: 1px solid var(--border-color-accent);
border-radius: var(--radius-sm);
background: var(--color-accent-soft);
padding: var(--size-1);
color: var(--color-accent);
font-size: var(--text-md);
}
looks much better:
Ah nice @aliabd thanks for catching both of those issues. Will fix soon |
Thanks again @aliabd! |
* escape triple quotes when creating space.py for custom components * Improve API docs * add changeset * revert * fix * changes * add changeset * fixes --------- Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
Some small improvements to the API docs as I start to look at the clients.
Closes: #2569
Closes: #6055
Here's how it looks locally:
Here's how it looks on Spaces (note that we now use Space ID instead of the ugly replica URL):