|
1 | 1 | # Change Log |
2 | 2 |
|
| 3 | +## 0.9.0 - 2020-08-24 |
| 4 | + |
| 5 | +This versions see's many great changes; utilising the β¬οΈ upgrade to `myst-parser=v0.12` |
| 6 | +and accompanying β¬οΈ upgrade to `sphinx=v3`, |
| 7 | +as well as major refactors to the execution ([#236](https://github.com/executablebooks/MyST-NB/commit/2bc0c11cedbad6206f70546819fad85d779ce449)) and code output rendering ([#243](https://github.com/executablebooks/MyST-NB/commit/04f3bbb928cf1794e140de6a919fb58578753300)). |
| 8 | +Plus much more configuration options, to allow for a more configurable workflow (the defaults work great as well!). |
| 9 | + |
| 10 | +Below is a summary of the changes, and you can also check out many examples in the documentation, <https://myst-nb.readthedocs.io/>, |
| 11 | +and the MyST-Parser Changelog for all the new Markdown parsing features available: <https://github.com/executablebooks/MyST-Parser>. |
| 12 | + |
| 13 | +### New β¨ |
| 14 | + |
| 15 | +- Custom notebook formats: |
| 16 | + |
| 17 | + Configuration and logic has been added for designating additional file types to be converted to Notebooks, which are then executed & parsed in the same manner as regular Notebooks. |
| 18 | + See [Custom Notebook Formats](https://myst-nb.readthedocs.io/en/latest/examples/custom-formats.html) for details. |
| 19 | + |
| 20 | +- Allow for configuration of render priority (per output format) with `nb_render_priority`. |
| 21 | + |
| 22 | +- The code cell output renderer class is now loaded from an entry-point, with a configurable name, |
| 23 | + meaning that anyone can provide their own renderer subclass. |
| 24 | + See [Customise the render process](https://myst-nb.readthedocs.io/en/latest/use/formatting_outputs.html#customise-the-render-process) for details. |
| 25 | + |
| 26 | +- Assignment of metadata tags `remove-stdout` and `remove-stderr` for removal of the relevant outputs ([see here](https://myst-nb.readthedocs.io/en/latest/use/formatting_outputs.html#removing-stdout-and-stderr)) |
| 27 | + |
| 28 | +- Render `text/markdown` MIME types with an integrated CommonMark parser ([see here](https://myst-nb.readthedocs.io/en/latest/use/formatting_outputs.html#markdown)). |
| 29 | + |
| 30 | +- Add code output image formatting, *via* cell metadata, including size, captions and labelling ([see here](https://myst-nb.readthedocs.io/en/latest/use/formatting_outputs.html#images)). |
| 31 | + |
| 32 | +- Notebook outputs ANSI lexer which is applied to stdout/stderr and text/plain outputs, and is configurable *via* `nb_render_text_lexer` ([see here](https://myst-nb.readthedocs.io/en/latest/use/formatting_outputs.html#ansi-outputs)). |
| 33 | + |
| 34 | +- Capture execution data in sphinx env, which can be output into the documentation, with the `nb-exec-table` directive. See [Execution statistics](https://myst-nb.readthedocs.io/en/latest/use/execute.html#execution-statistics) for details. |
| 35 | + |
| 36 | +### Improved π |
| 37 | + |
| 38 | +- Standardise auto/cache execution |
| 39 | + |
| 40 | + Both now call the same underlying function (from `jupyter-cache`) and act the same. |
| 41 | + This improves `auto`, by making it output error reports and not raising an exception on an error. |
| 42 | + Additional config has also been added: `execution_allow_errors` and `execution_in_temp`. |
| 43 | + As for for `timeout`, `allow_errors` can also be set in the notebook `metadata.execution.allow_errors` |
| 44 | + This presents one breaking change, in that `cache` will now by default execute in a the local folder as the CWD (not a temporary one). |
| 45 | + |
| 46 | +### Fixed π |
| 47 | + |
| 48 | +- Code cell source code is now assigned the correct lexer when using custom kernels ([39c1bb9](https://github.com/executablebooks/MyST-NB/commit/39c1bb99e73b35812474366f2f1760850fe40a57)) |
| 49 | + |
| 50 | +### Documented π |
| 51 | + |
| 52 | +- Add example of using kernels other than Python ([676eb2c](https://github.com/executablebooks/MyST-NB/commit/676eb2c46b1ca605980180479c845b43ec64c5fb)) |
| 53 | + |
| 54 | +### Refactored β»οΈ |
| 55 | + |
| 56 | +- Add more signature typing and docstrings |
| 57 | +- Move config value validation to separate function |
| 58 | +- Rename functions in cache.py and improve their logical flow |
| 59 | +- Rename variable stored in sphinx environment, to share same suffix: |
| 60 | + - `path_to_cache` -> `nb_path_to_cache` |
| 61 | + - `allowed_nb_exec_suffixes` -> `nb_allowed_exec_suffixes` |
| 62 | + - `excluded_nb_exec_paths` -> `nb_excluded_exec_paths` |
| 63 | +- Initial Nb output rendering: |
| 64 | + - Ensure source (path, lineno) are correctly propagated to `CellOutputBundleNode` |
| 65 | + - Capture cell level metadata in `CellOutputBundleNode` |
| 66 | + - New `CellOutputRenderer` class to contain render methods |
| 67 | + - Simplify test code, using sphinx `get_doctree` and `get_and_resolve_doctree` methods |
| 68 | + |
3 | 69 | ## 0.8.5 - 2020-08-11 |
4 | 70 |
|
5 | | -### Improved β¨ |
| 71 | +### Improved π |
6 | 72 |
|
7 | 73 | - Add configuration for traceback in stderr (#218) |
8 | 74 |
|
|
0 commit comments