Skip to content

Commit

Permalink
fix: use correct nbconvert config (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
ReenigneArcher authored Aug 18, 2024
1 parent 8d20c65 commit 801647b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ jobs:
run: |
jupyter nbconvert \
--debug \
--config=./jupyter_notebook_config.py \
--config=./jupyter_nbconvert_config.py \
--execute \
--no-input \
--to=html \
Expand Down
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# dashboard
A Jupyter notebook that creates a dashboard for viewing LizardByte repository data.

## Notes:
`ploty.js` must exist in the notebooks directory for the dashboard to be viewable by nbviewer.org.
It can be downloaded from their cdn: https://github.com/plotly/plotly.js/?tab=readme-ov-file#the-script-html-element
## Contributing

You can create a replica of the nbviewer.org dashboard by running the following command in the terminal:
1. Notebooks should be committed with the output cleared.
```bash
jupyter nbconvert --to notebook --ClearOutputPreprocessor.enabled=True --inplace ./notebook/dashboard.ipynb
```

```bash
jupyter nbconvert --to html notebook/dashboard.ipynb
```
2. You can create a preview of the notebook in html by running the following commands:
```bash
npm install
cp -f ./node_modules/ploty.js/dist/plotly.min.js ./gh-pages/plotly.js
jupyter nbconvert \
--debug \
--config=./jupyter_nbconvert_config.py \
--execute \
--no-input \
--to=html \
--output-dir=./gh-pages \
--output=index \
./notebook/dashboard.ipynb
```

0 comments on commit 801647b

Please sign in to comment.