https://github.com/deepchecks/gallery-boilerplate
https://github.com/deepchecks/gallery-boilerplate
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/deepchecks/gallery-boilerplate
- Owner: deepchecks
- Created: 2022-04-03T08:55:08.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T11:45:13.000Z (over 1 year ago)
- Last Synced: 2025-01-11T19:50:45.512Z (3 months ago)
- Language: Python
- Size: 86.9 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gallery-boilerplate
This boilerplate repository is to facilitate implementation of a sphinx gallery
plot.
## Installtion
### Clone the repository:
`git clone https://github.com/deepchecks/gallery-boilerplate.git`
### Create virtualenv
You will need python 3
`cd gallery-boilerplate && virtualenv venv`
### Install required packages
`pip install -r requirements.txt`
If you use other libraries to generate a plot you can add those to this file.
For example, since we are using `deepchecks` then install that using
`pip install deepchecks` then you will be able to plot using deepchecks.
## Writing plot
Edit `source/plot/plot_test.py`
## Generate plot
`make html`
## Copy files to webserver
If you have `nginx` or `apache` running with root `/var/www` then do
`cp -r build/html/* /var/www` and hit http://localhost/ you will see gallery thumbnail.