Sphinxcontrib Jupyter Versions Save

This minor release allows for download notebooks to be executed for the html site generator through the conf.py setting:

jupyter_download_nb_execute = True

Features:

• FEAT: Execute downloaded notebooks #269 (AakashGfude)

This minor release includes:

1. a new feature that allows authors to add dependent files through conf.py at the notebook and the directory level (as defined in your source directory). When the notebook is generated these dependencies will now be copied to the _build folder to support execution.

jupyter_dependencies = {
    'getting_started_julia': ['Manifest.toml', 'Project.toml'],
}

2. [make website] jupyter_download_nb has an option to update all images and figures to reference a remote server location for the _download notebooks. The option jupyter_images_urlpath is no longer a generic option and has been deprecated in favour of jupyter_download_nb_image_urlpath. This option only applies to the download set of notebooks and won't affect make jupyter, make website for core html files etc. These files will default to using relative references.

New Features:

• ENH: Setting jupyter_images_urlpath only for downloads folder #252 (AakashGfude)
• ENH: File folder dependency #250 (AakashGfude)

Bug Fixes:

• Fix: slide fragment option not getting parsed correctly #253 (mmcky)
• Remove egg cfg to remove dev status on version releases #254 (mmcky)

Testing:

• TEST: add :class: attribute test for literalinclude #255 (mmcky)

This release contains bug fixes and minor updates to docs.

Bug Fixes:

• Fix build by checking lengh of uri string before accessing first element #248 (sglyon)
• DOCS: update docs for new file/dir dependencies #245 (mmcky)

This is the v0.4.1 release of sphinxcontrib-jupyter via PyPI.

It includes more enhancements and new features than are usually attributed to a minor release, however were added as they were requested for expedited integration.

New Features:

• ENH: enhance the exercise directives and add new exerciselist directive #239 (sglyon)
• ENH: Theme folder variables #233 (AakashGfude)
• ENH: Added functionality to specify file dependencies in config #232 (AakashGfude)

Documentation:

• DOC: Fix typo in docs/installation.rst #240 (slel)
• DOC: Edits and additions to documentation #238 (mmcky) #227 (mmcky)

This is a v0.4.0 release of sphinxcontrib-jupyter for release via PyPI.

The main additions to this release include:

1. enabled execution for notebooks (using dask.futures)
2. enabled website construction using nbconvert and html template
3. enabled generation of coverage statistics with options to include tests

Many thanks to the contributions made during this release cycle: AakashGfude and sglyon. Your PR's and improvements are greatly valued.

New Features

• ENH: Add compatibility with Sphinx=2.1.2 #213 (mmcky)
• ENH: Add jupyter_target_pdf option for upcoming pdf compilation pipeline due in v0.5.0 #210 (mmcky)
• ENH: Coverage reports #195 (AakashGfude)
• FEAT: add option to write images as markdown rather than html #194 (mmcky)
• FEAT: Add coverage reports for execution testing #190 (AakashGfude)
• FEAT: Enable making websites from jupyter notebooks #185 (AakashGfude)
• FEAT: Add nbconvert conversion from IPYNB to HTML #176 (mmcky)
• FEAT: Add control for notebook execution, coverage reports, and error capture #170 (AakashGfude)
• ENH: added exercises directive #164 (sglyon)

Bug Fixes

• BUG: suppress yaml warnings for now, remove once dask is > 0.45 #224 (mmcky)
• FIX: Jupyter_conversion_mode "all" by default #222 (AakashGfude)
• FIX: Fix various defaults for config options and improve BUILDDIR targeting to be specified in Makefile #207 (mmcky)
• FIX: path was incorrect for copying some static assets #187 (mmcky)
• adding default 1 for threads in builder init #186 (AakashGfude)
• config object check #184 (AakashGfude)
• added a check for code blocks when escaping #175 (AakashGfude)
• FIX: adjust relative uri references #172 (mmcky)
• FIX: enable latex writer to compile #168 (mmcky)
• BUG: fix issue when parsing $ sign as special markdown syntax #165 (mmcky)
• FIX: Index items were always adding a # even if no internal id #162 (mmcky)

Documentation

• UPDATE: Documentation #221 (mmcky)

Testing Updates

Testing has been adjusted to include configuration sets base and pdf. This allows for testing of different conf.py files based on the different compilation pipelines now available in the extension. More updates will be coming to add html.

This is a v0.3.0 release of sphinxcontrib-jupyter for release via PyPI.

There have been a lot of improvements for this release as documented below.

Note: This version is now compatible with sphinx=1.8+ and sphinx=1.7+

Many thanks to the contributions made during this release cycle: arnavs, chabotsi, FelipeMaldonado, and nthiery (in alphabetical order). Your PR's and improvements are greatly valued.

New Features

1. Support sphinx >= 1.8 #156 (chabotsi)
2. Easier support for compiling notebooks with local images #155 (mmcky)
3. Update displaymath to use Latex tags rather than html table wrappers #154 (mmcky)
4. Add metadata for hide-output pass through to an nb_executor #153 (mmcky)
5. Add jupyter_target_html_urlprefix option #147 (mmcky)
6. Directive to add a dependent file copied to notebook location #142 (mmcky)
7. add urlprefix capability for images in notebooks #138 (mmcky)
8. add ignore for globally skipping skip-test flag in code-blocks #131 (mmcky)
9. Add global ignore to no-execute code-blocks #129 (mmcky)
10. Allow target html for footnotes #126 (mmcky)
11. Add html target for adding footnotes (to allow nbconvert passthrough) #119 (mmcky)
12. Add :output: to Jupyter Directive #115 (FelipeMaldonado)
13. allow html targeting in links for use with nbconvert #113 (mmcky)
14. Add slideshow option into the metadata #112 (FelipeMaldonado)
15. add support for toctree objects #111 (mmcky)
16. adding support for language synonyms such as python and ipython #110 (mmcky)
17. add support for download directives #106 (mmcky)
18. Pass through for collapse class for html writers #105 (mmcky)
19. Add support for footnotes rubric #99 (mmcky)
20. Add support for epigraph nodes #97 (mmcky)
21. allow jupyter notebooks to capture html only blocks in output #92 (mmcky)
22. Add ignore for comments in RST #87 (mmcky)
23. Add support for inline literal markup in RST #86 (mmcky)
24. Add support to skip only directives that are not jupyter #85 (mmcky)
25. Add Jupyter directive for specifying breaks in markdown cells #84 (FelipeMaldonado)
26. Add support for note node type as blockquote markdown #81 (mmcky)
27. Add test class #78 (arnavs)
28. Add support for solutions class #72 (mmcky)
29. Add configuration keyword for specifying the default language of the jupyter notebook #64 (nthiery)
30. Improved support for nested code blocks #63 (nthiery)
31. Python 2 support #62 (nthiery)

Bug Fixes

1. Interspersed Lists and Code #144
2. Rendering (not ignoring) TODO #24
3. fix implementation for notes to follow internal markup of Text #90 (mmcky)
4. Fix small displaymath equation issue using a local font resize div #152 (mmcky)
5. Fix internal links issue using ) and ( #151 (mmcky)
6. Make more robust to varying directory structures for dependent files #146 (mmcky)
7. Change to text for none highlight in markdown #141 (mmcky)
8. Fix markdown when no language is specified for highlighting #140 (mmcky)
9. adjust inline math in contents when targeting html #132 (mmcky)
10. fix spacing issue in markdown after leaving raw directives #128 (mmcky)
11. fix displaymath issue when in list #114 (mmcky)
12. Migrate blockquote to use Markdown > syntax #100 (mmcky)
13. Fix epigraph bug due to no trailing newline in markdown #98 (mmcky)
14. fix issue with odd number of spaces breaking nested lists #93 (mmcky)
15. resolve error with windows delimiters #67 (arnavs)

Testing Updates

1. update math test with additional referenced equations #118 (mmcky)
2. update test for code-blocks with special case with none highlighter #96 (mmcky)
3. update to math test with more complete inline test cases #95 (mmcky)
4. add test for literal include directives #94 (mmcky)
5. improve testing for nested lists #75 (mmcky)
6. Run tests on all generated notebooks, without stopping upon first failure #61 (nthiery)

This is a v0.2.1-beta release to update PyPI with the latest features.

New features

• Add support for blockquotes in rst files (#42)
• Add support for html based image links when added to notebook markdown cells (#45)
• Added basic rst to markdown table support (85fca6065863d9a9635b9af66927ac149c93a88c)

Bug Fixes

• Equation numbering for labelled display math in jupyter notebook (#47)

Testing Infrastructure

This release adds testing infrastructure and a set of output notebooks that displays the relationship between rst and ipynb output. The test suite will run through travis-ci with continuous integration. These tests are located in tests/ with expected reference jupyter output located in tests/ipynb.

• To run the test added to support labelled display math (#47) sphinx version >=1.7.2 is required. The extension itself will however still work with earlier versions of sphinx, but for the test requires exact output for how html tables are constructed.
• tests ignore the metadata that is embedded in notebooks including python to focus on content only.
• uses nbdime as a library to compare generated and reference notebooks

A complete minimal example is now available here