mirror/gradio
2
0
Fork 0
mirror of https://github.com/gradio-app/gradio.git synced 2024-12-03 01:50:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
d82dfb886d
gradio/website
History
Shavit 1fc8c5fd8c
Throttle scroll event (#4158) 
* Throttle scroll event

This decreases the amount of function calls when scrolling through the documentation website.

* fix themes base

---------

Co-authored-by: Abubakar Abid <abubakar@huggingface.co>
Co-authored-by: Ali Abdalla <ali.si3luwa@gmail.com>
2023-06-02 18:22:47 +04:00
..
homepage Throttle scroll event (#4158) 2023-06-02 18:22:47 +04:00
.gitignore Remove old versioned docs and fix repo classification (#4362) 2023-06-01 18:38:53 -07:00
check_version.py Switch linting to Ruff (#3710) 2023-04-03 15:48:18 -07:00
docker-compose.yml Dropdown for seeing docs as latest or main (#2544) 2022-11-08 13:02:05 +01:00
gradio.nginx.conf Upload all demos to spaces (#2281) 2022-10-14 14:07:26 -07:00
package-lock.json
README.md Update website README.md with correct instructions on how to build website (#2858) 2022-12-21 18:41:02 +04:00
reload_website.sh export latest commit variable (#2645) 2022-11-14 16:17:33 -05:00
reload_with_notification.sh

README.md

The Gradio Website

The Gradio website (https://gradio.app) is built from the contents of this folder. The website is tightly coupled with the rest of the repository through several ways:

  • The documentation loaded from the docstrings of the objects themselves, and is generated using the gradio library in the gradio folder of this repository. If you want to see changes you made to the docstrings in the library, please install an editable version of the library from root of the directory: pip install gradio -e .
  • The demos are loaded from the gradio/demo folder, hosted on spaces, and linked to the documentation in the docstrings of the documented object.
  • The guide pages are loaded from the gradio/guides folder

The website is launched through the docker-compose.yml file in this directory.

You can run the entire website by:

  • Installing nginx
  • Copying gradio.nginx.conf from this folder to /etc/nginx/conf.d/gradio.nginx.conf
  • Running docker-compose build && docker-compose up
  • (Re)starting nginx

This will serve the website on port 80 (you can change the port from the gradio.nginx.conf file)

Alternatively, for development, read the homepage section below:

The homepage docker

The homepage folder builds the static content of the website into standalone files, served by nginx in docker. For development purposes, instead of running docker to test changes, just run sh scripts/launch_website.sh from the root of the repo.

Auto-Reloading

The website is built from the main branch and automatically reloads on commits to main.