Skip to content
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

Include example notebooks as data files in package #2831

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

SylvainCorlay
Copy link
Member

@SylvainCorlay SylvainCorlay commented Mar 22, 2020

IPywidgets users who installed ipywidgets from PyPI or conda often have to consult the GitHub repository to find example notebooks.

In this PR we include the notebooks in the package as data files, so that they are installed alongside the package.

These "example notebooks" are picked up by lab extensions such as jupyterlab templates.

I would like to adopt this approach to include example notebooks with libraries.

@SylvainCorlay SylvainCorlay force-pushed the include-notebooks-in-package branch from fb61b21 to 239feaa Compare March 22, 2020 23:54
@vidartf

This comment has been minimized.

@SylvainCorlay SylvainCorlay force-pushed the include-notebooks-in-package branch 6 times, most recently from 211290f to 6ff0929 Compare March 27, 2020 11:44
@SylvainCorlay SylvainCorlay changed the title WIP - Include example notebooks as data files in package Include example notebooks as data files in package Mar 27, 2020

html:
rm -rf ./source/notebooks/ && mkdir ./source/notebooks && cp -r ./../share/jupyter/notebook_templates/ipywidgets/* ./source/notebooks/
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not very happy that we need to refer to the current (makefile) directory as .. There is no variable storing the location of the makefile.

@vidartf
Copy link
Member

vidartf commented Mar 30, 2020

Note that this would likely also need a change to the make.bat file corresponding to the docs Makefile changes. An alternative could be to use https://github.com/vidartf/nbsphinx-link :)

@SylvainCorlay
Copy link
Member Author

Note that this would likely also need a change to the make.bat file corresponding to the docs Makefile changes.

Yes

@SylvainCorlay SylvainCorlay force-pushed the include-notebooks-in-package branch from 6ff0929 to af7d60a Compare May 15, 2020 13:56
@vidartf vidartf added this to the 8.1 milestone Aug 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants