-
Notifications
You must be signed in to change notification settings - Fork 507
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
updating documentation #126
Conversation
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.
Thanks!
Indeed, templates and nbconvert options are probably the most important extension points to document.
docs/source/customize.rst
Outdated
|
||
In order to create your own template, first familiarize yourself with **Jinja**, | ||
**HTML**, and **CSS**. Each of these is used in creating custom templates. | ||
For reference, see the TODO: link to nbconvert documentation as well as the |
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.
This may be intereting to specify how passing extra NbConvert options to the command line.
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.
This isn't currently possible though, right?
Quick question: I believe that I've got a custom Voila template properly created / located, but Voila doesn't seem to be using the custom template that I've created: Looking at the logs, it seems like even though the custom template path is there (it's in
Once the actual template is applied, the custom template path comes after the default template path.
Any idea why this would happen? (also see latest push for the commands that I used, more or less) |
@choldgraf thanks! Let me know if you think this is ready! |
@SylvainCorlay see my previous comment: #126 (comment) I'm currently blocking on actually getting the custom template to be used. I haven't had time yet to dig into the code and figure out what's going wrong, but will try giving it a shot soon |
README.md
Outdated
@@ -1,7 +1,7 @@ | |||
# Voila | |||
|
|||
[![Documentation](http://readthedocs.org/projects/voila/badge/?version=latest)](https://voila.readthedocs.io/en/latest/?badge=latest) | |||
[![Binder](https://img.shields.io/badge/launch-binder-brightgreen.svg)](https://mybinder.org/v2/gh/QuantStack/voila/stable?urlpath=voila/tree/notebooks) | |||
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/QuantStack/voila/master?urlpath=voila%2Ftree%2Fnotebooks) |
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.
We prefer using the stable
branch for the binder rather than voila. stable
is only updated upon releases.
docs/doc-requirements.txt
Outdated
@@ -0,0 +1,2 @@ | |||
sphinx_copybutton | |||
alabaster_jupyterhub |
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.
Do we need alabaster_jupyterhub?
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.
nope, it's copypasta, I'll remove it
How are you invoking the template? |
|
Digging into it a little bit more, it seems like something weird is going on w/ my template paths when I run voila. The problem seems to be that the list print(self.nbconvert_template_paths) When the
However if I then do the same thing within
So it seems like somehow that list is changing, and in the second case, the |
Thanks @choldgraf I have left a couple of inline comments (regarding the binder and the requirements file). Let me know when this is fixed an I am happy to merge. |
@SylvainCorlay see my latest comment for the blocker on this (#126 (comment)) There are a few challenges for me:
So...if you want I can just spot-check your suggestions and then figure the other stuff out later, but I can't tell if this documentation actually works or not |
This is really surprising as we have been making several different voila templates. Will look into this. |
@choldgraf that duplicate template path was a bug that is fixed, the new release (0.1) should fix that. |
Correction: we published 0.0.10. I am waiting on the jupyterlab theme for 0.1. |
ok lemme upgrade and see if that fixes it |
it worked for me! wohoo! |
ok I'm +1 on merging this whenever y'all are happy with it - happy to continue spot-checking docs in other PRs as well as I continue to learn the codebase better (and if I can ever get the damn thing installed in developer mode) |
This updates a bit of the documentation that's contained in the readthedocs folder...it doesn't try to do too much other than adding a few new pieces of content. There's probably some information in there that isn't quite correct, so please feel free to give comments and/or edits!
cc @SylvainCorlay who I chatted about this with!