-
-
Notifications
You must be signed in to change notification settings - Fork 23
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
FEAT: Support for general static asset source locations #268
base: master
Are you sure you want to change the base?
Conversation
@AakashGfude currently |
Note: The download |
|
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remote images work for me now -- thank you
thanks for testing @sglyon -- this is on hold for a week as we get |
Testing
|
Exception occurred:
File "/home/qebuild/repos/sphinxcontrib-jupyter/sphinxcontrib/jupyter/writers/translate_all.py", line 206, in visit_image
elif uri not in self.builder.image_library.keys():
AttributeError: 'JupyterPDFBuilder' object has no attribute 'image_library' |
@sglyon @arnavs @AakashGfude -- just wanted to check in now that This is subotimal in one usage case -- which is distributing notebooks (along with static) assets. For example someone may want a notebook and some statics to go along with it when teaching a class. This change would make it hard to distribute a notebook and any static assets as they are embedded in the |
@mmcky no ideas as such popping out now, the implementation looks sleek. Regarding the distribution of assets. Maybe in the later stage maybe we can have a parent directory which has all the folders like |
@mmcky I am not sure I understand the issues here and whether this has any practical effects. Just to be clear, when you talk about notebooks are you talking about the intermediate juptyer format or the final notebooks being spit out for the github repo?
So, assuming we don't want to have any static assets deployed (outside of the stuff we used to discuss of putting the Manifest/Project/etc. in the same directory structure for execution) does this effect us? |
thanks @jlperla for your comments. The primary issue is when To be clear there are a lot of different notebook types now. The use cases for our lecture sites is pretty much covered:
there is another
This PR mimics the standard |
This all sounds like a reasonable iteration on the design (although I don't need to follow it all!) Does this have a concrete impact on the julia and datascience lectures, how we write the RST, changing what we currently deploy, etc? Or are you mostly just giving us a heads up that large changes are afoot? |
hey @jlperla no -- all of these changes are internal to the extension. No changes to It will change config -- (i.e. web links for images etc.) -- but that will need to managed if this get's merged. |
Sounds great to me! If I think of anything, I will mention it. Though I don't have a mental model of sphinx, so it is unlikley. |
Note: Placing this on hold as we evaluate the extension in |
this PR provides one implementation idea for managing static assets. This PR will not be merged as the underlying extension has significantly changed. But this PR contains some interesting ideas. |
This PR allows for more flexible source files to be specified in the
RST
documents and will organise them based on type in theBUILD
directory. Allimages
will be located inBUILDDIR/_images
and alldownloads
will be placed inBUILDDIR/_downloads
. Only the assets referenced in the sourceRST
files will be copied to the build location._images
_downloads
_static
assets folder_static
BUILDDIR
toexecuted
directoryBUILDDIR/jupyter/
toBUILDDIR/jupyter_html
formake site