search

QuantEcon / sphinxcontrib-jupyter

A Sphinx Extension for Generating Jupyter Notebooks
BSD 3-Clause "New" or "Revised" License
76 stars 23 forks source link

FEAT: Add nbconvert conversion from IPYNB to HTML #176

Closed mmcky closed 5 years ago

mmcky commented 5 years ago

This PR adds the ability to compile html from a collection of generated notebooks using nbconvert. This supports the use of templates to allow for customisation of pages during the conversion process.

To allow this functionality add the following keys to conf.py configuration file.

`# generate html from IPYNB files

jupyter_generate_html = True jupyter_html_template = "/path-to-template.tpl"`

This PR also has all the code of :- https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/170 on top of which it is built.

mmcky commented 5 years ago

@AakashGfude thanks for all your work on this branch! I have just setup this PR for visibility of this new upcoming feature. Can you update the description with how to configure and use the html conversion. Thanks.

AakashGfude commented 5 years ago

@AakashGfude thanks for all your work on this branch! I have just setup this PR for visibility of this new upcoming feature. Can you update the description with how to configure and use the html conversion. Thanks.

Done

arnavs commented 5 years ago

@AakashGfude if this is the thing you sent me, I think it's good to go on our end.

mmcky commented 5 years ago

thanks @AakashGfude this is looking great. Can you update CI or do you need me to look into that?

mmcky commented 5 years ago

thanks @AakashGfude. When you get the chance can you update docs to include this feature.

AakashGfude commented 5 years ago

thanks @AakashGfude. When you get the chance can you update docs to include this feature.

@mmcky had written the conf variables needed at the end of the Configuration heading in README.md . and had modified the summary to include the functionalities. Do tell me if I should add something more.

mmcky commented 5 years ago

hey @AakashGfude would you mind updating this PR to remove the conflicts?

mmcky commented 5 years ago

@AakashGfude let me know when you get this updated via slack and then I will merge and start updating the build server and getting preview updated.

mmcky commented 5 years ago

thanks @AakashGfude. This is a great addition.