Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcskovmadsen/sphinx-gallery-panel-example
An example of a sphinx-gallery using Panel
https://github.com/marcskovmadsen/sphinx-gallery-panel-example
Last synced: 8 days ago
JSON representation
An example of a sphinx-gallery using Panel
- Host: GitHub
- URL: https://github.com/marcskovmadsen/sphinx-gallery-panel-example
- Owner: MarcSkovMadsen
- License: mit
- Created: 2023-09-16T04:46:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-30T04:58:13.000Z (about 1 year ago)
- Last Synced: 2024-10-24T10:14:34.159Z (21 days ago)
- Language: HTML
- Size: 6.63 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sphinx Gallery - Panel Example
An example of a minimal [sphinx-gallery](https://sphinx-gallery.github.io/stable/index.html) that works with [Panel](https://panel.holoviz.org/).
See
- the feature request in [panel#5519](https://github.com/holoviz/panel/issues/5519)
- the discussion in [holoviz/discourse#6035](https://discourse.holoviz.org/t/how-to-use-sphinx-gallery-with-panel/6035)
for more context.
## Install the project
```bash
git clone https://github.com/MarcSkovMadsen/sphinx-gallery-panel-example.git
cd sphinx-gallery-panel-example
python -m venv .venv
source .venv/bin/activate # linux. Use similar command for windows or macos
pip install -r requirements.txt
```
## Serve the examples
```bash
panel serve examples/*.py examples/**/*.py --autoreload
```
## Develop the gallery
### Build
```bash
sphinx-build -b html docs docs/_build/html
```
### Serve
You can start a web server to view the project locally using
```bash
python -m http.server -d docs/_build/html/
```
The project is available at [http://localhost:8000](http://localhost:8000).
### Rebuild
Remove the `docs/examples` folder and build again.
```bash
rm -rf docs/examples/;sphinx-build -b html docs docs/_build/html
```