Sphinxcontrib-jupyter

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](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/248) ([sglyon](https://github.com/sglyon))
- DOCS: update docs for new file/dir dependencies [\245](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/245) ([mmcky](https://github.com/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](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/239) ([sglyon](https://github.com/sglyon))
- ENH: Theme folder variables [\233](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/233) ([AakashGfude](https://github.com/AakashGfude))
- ENH: Added functionality to specify file dependencies in config [\232](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/232) ([AakashGfude](https://github.com/AakashGfude))

**Documentation:**

- DOC: Fix typo in docs/installation.rst [\240](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/240) ([slel](https://github.com/slel))
- DOC: Edits and additions to documentation [\238](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/238) ([mmcky](https://github.com/mmcky)) [\227](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/227) ([mmcky](https://github.com/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`)
1. enabled website construction using `nbconvert` and html template
1. enabled generation of `coverage` statistics with options to include tests

Many thanks to the contributions made during this release cycle: [AakashGfude](https://github.com/AakashGfude) and [sglyon](https://github.com/sglyon). Your PR's and improvements are greatly valued.

New Features

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


Bug Fixes

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

Documentation

- UPDATE: Documentation [\221](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/221) ([mmcky](https://github.com/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](https://github.com/arnavs), [chabotsi](https://github.com/chabotsi), [FelipeMaldonado](https://github.com/FelipeMaldonado), and [nthiery](https://github.com/nthiery) (in alphabetical order). Your PR's and improvements are greatly valued.

New Features

1. Support sphinx \>= 1.8 [\156](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/156) ([chabotsi](https://github.com/chabotsi))
1. Easier support for compiling notebooks with local images [\155](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/155) ([mmcky](https://github.com/mmcky))
1. Update displaymath to use Latex tags rather than html table wrappers [\154](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/154) ([mmcky](https://github.com/mmcky))
1. Add metadata for hide-output pass through to an nb\_executor [\153](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/153) ([mmcky](https://github.com/mmcky))
1. Add jupyter\_target\_html\_urlprefix option [\147](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/147) ([mmcky](https://github.com/mmcky))
1. Directive to add a dependent file copied to notebook location [\142](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/142) ([mmcky](https://github.com/mmcky))
1. add urlprefix capability for images in notebooks [\138](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/138) ([mmcky](https://github.com/mmcky))
1. add ignore for globally skipping skip-test flag in code-blocks [\131](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/131) ([mmcky](https://github.com/mmcky))
1. Add global ignore to no-execute code-blocks [\129](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/129) ([mmcky](https://github.com/mmcky))
1. Allow target html for footnotes [\126](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/126) ([mmcky](https://github.com/mmcky))
1. Add html target for adding footnotes \(to allow nbconvert passthrough\) [\119](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/119) ([mmcky](https://github.com/mmcky))
1. Add :output: to Jupyter Directive [\115](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/115) ([FelipeMaldonado](https://github.com/FelipeMaldonado))
1. allow html targeting in links for use with nbconvert [\113](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/113) ([mmcky](https://github.com/mmcky))
1. Add slideshow option into the metadata [\112](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/112) ([FelipeMaldonado](https://github.com/FelipeMaldonado))
1. add support for toctree objects [\111](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/111) ([mmcky](https://github.com/mmcky))
1. adding support for language synonyms such as python and ipython [\110](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/110) ([mmcky](https://github.com/mmcky))
1. add support for download directives [\106](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/106) ([mmcky](https://github.com/mmcky))
1. Pass through for `collapse` class for html writers [\105](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/105) ([mmcky](https://github.com/mmcky))
1. Add support for footnotes rubric [\99](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/99) ([mmcky](https://github.com/mmcky))
1. Add support for epigraph nodes [\97](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/97) ([mmcky](https://github.com/mmcky))
1. allow jupyter notebooks to capture html only blocks in output [\92](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/92) ([mmcky](https://github.com/mmcky))
1. Add ignore for comments in RST [\87](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/87) ([mmcky](https://github.com/mmcky))
1. Add support for inline literal markup in RST [\86](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/86) ([mmcky](https://github.com/mmcky))
1. Add support to skip only directives that are not jupyter [\85](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/85) ([mmcky](https://github.com/mmcky))
1. Add Jupyter directive for specifying breaks in markdown cells [\84](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/84) ([FelipeMaldonado](https://github.com/FelipeMaldonado))
1. Add support for note node type as blockquote markdown [\81](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/81) ([mmcky](https://github.com/mmcky))
1. Add test class [\78](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/78) ([arnavs](https://github.com/arnavs))
1. Add support for solutions class [\72](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/72) ([mmcky](https://github.com/mmcky))
1. Add configuration keyword for specifying the default language of the jupyter notebook [\64](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/64) ([nthiery](https://github.com/nthiery))
1. Improved support for nested code blocks [\63](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/63) ([nthiery](https://github.com/nthiery))
1. Python 2 support [\62](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/62) ([nthiery](https://github.com/nthiery))

Bug Fixes

1. Interspersed Lists and Code [\144](https://github.com/QuantEcon/sphinxcontrib-jupyter/issues/144)
1. Rendering \(not ignoring\) TODO [\24](https://github.com/QuantEcon/sphinxcontrib-jupyter/issues/24)
1. fix implementation for notes to follow internal markup of Text [\90](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/90) ([mmcky](https://github.com/mmcky))
1. Fix small displaymath equation issue using a local font resize div [\152](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/152) ([mmcky](https://github.com/mmcky))
1. Fix internal links issue using \) and \( [\151](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/151) ([mmcky](https://github.com/mmcky))
1. Make more robust to varying directory structures for dependent files [\146](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/146) ([mmcky](https://github.com/mmcky))
1. Change to text for none highlight in markdown [\141](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/141) ([mmcky](https://github.com/mmcky))
1. Fix markdown when no language is specified for highlighting [\140](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/140) ([mmcky](https://github.com/mmcky))
1. adjust inline math in contents when targeting html [\132](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/132) ([mmcky](https://github.com/mmcky))
1. fix spacing issue in markdown after leaving raw directives [\128](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/128) ([mmcky](https://github.com/mmcky))
1. fix displaymath issue when in list [\114](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/114) ([mmcky](https://github.com/mmcky))
1. Migrate blockquote to use Markdown \> syntax [\100](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/100) ([mmcky](https://github.com/mmcky))
1. Fix epigraph bug due to no trailing newline in markdown [\98](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/98) ([mmcky](https://github.com/mmcky))
1. fix issue with odd number of spaces breaking nested lists [\93](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/93) ([mmcky](https://github.com/mmcky))
1. resolve error with windows delimiters [\67](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/67) ([arnavs](https://github.com/arnavs))

Testing Updates
1. update math test with additional referenced equations [\118](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/118) ([mmcky](https://github.com/mmcky))
1. update test for code-blocks with special case with none highlighter [\96](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/96) ([mmcky](https://github.com/mmcky))
1. update to math test with more complete inline test cases [\95](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/95) ([mmcky](https://github.com/mmcky))
1. add test for literal include directives [\94](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/94) ([mmcky](https://github.com/mmcky))
1. improve testing for nested lists [\75](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/75) ([mmcky](https://github.com/mmcky))
1. Run tests on all generated notebooks, without stopping upon first failure [\61](https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/61) ([nthiery](https://github.com/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](https://github.com/QuantEcon/sphinxcontrib-jupyter.minimal)