Skip to content

Commit

Permalink
Version 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mwouts committed Apr 14, 2019
1 parent eb357eb commit 62f773e
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
5 changes: 3 additions & 2 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Release History
---------------

1.1.0 (2019-04-??)
1.1.0 (2019-04-14)
++++++++++++++++++++++

**Improvements**
Expand All @@ -15,8 +15,9 @@ Release History
**BugFixes**

- Jupytext's contents manager is now based on ``LargeFileManager`` to allow large file uploads (#210)
- YAML header parsed with yaml.safe_load rather than yaml.load
- YAML header parsed with yaml.safe_load rather than yaml.load (#215)
- IPython line magic can be split across lines (#209)
- ``jupytext --to py`` rather than ``--to python`` in the README (#216)


1.0.5 (2019-03-26)
Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,11 +349,16 @@ c.ContentsManager.split_at_heading = True

### Pandoc's Markdown

Pandoc, the _Universal document converter_, can now read and write Jupyter notebooks - see [Pandoc's documentation](https://pandoc.org/MANUAL.html#creating-jupyter-notebooks-with-pandoc). The format name for Pandoc's Markdown in Jupytext is `md:pandoc` (requires `pandoc` in version 2.7.2 or above).
Pandoc, the _Universal document converter_, can now read and write Jupyter notebooks - see [Pandoc's documentation](https://pandoc.org/MANUAL.html#creating-jupyter-notebooks-with-pandoc).

Pandoc's format has explicit cell markers. See for instance how our `World population.ipynb` notebook is [represented](https://github.com/mwouts/jupytext/blob/master/demo/World%20population.pandoc.md) in that format. Please also note that `pandoc`, while preserving the HTML rendering, may reformat the text in some of the Markdown cells. If that is an issue for you, please wait until [jgm/pandoc#5408](https://github.com/jgm/pandoc/issues/5408) gets implemented.
Pandoc's Markdown format is available in Jupytext as `md:pandoc`. This requires `pandoc` in version 2.7.2 or above - please check Pandoc's version number with `pandoc -v` before running either `jupytext` command line, or before you start your Jupyter notebook or Lab server. Note that you can get the latest version of `pandoc` in a conda environment with
```
conda install pandoc -c conda-forge
```

Pandoc's format uses Pandoc divs (`:::`) as explicit cell markers. See how our `World population.ipynb` notebook is [represented](https://github.com/mwouts/jupytext/blob/master/demo/World%20population.pandoc.md) in that format. Please also note that `pandoc`, while preserving the HTML rendering, may reformat the text in some of the Markdown cells. If that is an issue for you, please wait until [jgm/pandoc#5408](https://github.com/jgm/pandoc/issues/5408) gets implemented.

As for the other formats, the `md:pandoc` format in Jupytext can be paired to an `.ipynb` file. For this reason, `jupytext` discards the output cells before calling `pandoc`. If you would like to see the outputs cells in the Markdown file, please use `pandoc` directly.
Jupytext currently strips the output cells before calling `pandoc`. As for the other formats, outputs cells can be preserved in paired notebooks. In the case of the pandoc format, paired notebooks are available with the metadata `"jupytext": {"formats": "md:pandoc,ipynb"}`.

### The `light` format for notebooks as scripts

Expand Down
2 changes: 1 addition & 1 deletion jupytext/version.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""Jupytext's version number"""

__version__ = '1.1.0rc2'
__version__ = '1.1.0'

0 comments on commit 62f773e

Please sign in to comment.