Skip to content

Commit

Permalink
Updated README. Resolved #28, #29, and #30.
Browse files Browse the repository at this point in the history
  • Loading branch information
kirbs- committed Feb 26, 2017
1 parent 92a7421 commit 72eb6dc
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@
![PyPI version](https://badge.fury.io/py/hide_code.svg) ![MIT license](https://img.shields.io/github/license/mashape/apistatus.svg)
Release: ![Travis release build](https://travis-ci.org/kirbs-/hide_code.svg?branch=master) Dev: ![Dev Build Status](https://travis-ci.org/kirbs-/hide_code.svg?branch=dev)

hide_code is an extension for Jupyter/IPython notebooks to selectively hide code, prompts and outputs. PDF and HTML export formats are fully supported.
hide_code is a Jupyter notebook extension to selectively hide code, prompts and outputs with PDF and HTML exporting support.

![](/images/demo.gif)
![demo](/images/demo.gif)

## Installation
1. `pip install hide_code`
2. `jupyter nbextension install --py hide_code`
3. `jupyter nbextension enable --py hide_code`
4. `jupyter server_extension enable --py hide_code`
4. `jupyter serverextension enable --py hide_code`

Note: add `--sys-prefix` to jupyter nbextension to install into virtualenv or conda environment.
Note: add `--sys-prefix` to `jupyter nbextension` to install into virtualenv or conda environment.

## Upgrading from 0.3.1?
Versions prior to 0.4 were installed by bootstrapping custom.js and jupyter configuration files. Pip uninstall does not remove these files. Upgrade to 0.4, then run `python -c "import hide_code; hide_code.uninstall_bootrapped_files()"`.

## Documentation
Visit the [Wiki](https://github.com/kirbs-/hide_code/wiki).

## Requirements
* Jupyter notebook 4.x+
* Jupyter nbconvert 4.2+ if using nbconvert command line exporting
* Jupyter nbconvert ~>4.2+ if using nbconvert command line exporting. nbconvert 5.x does not work with hide_code.
* pdfkit & [wkhtmltopdf](http://wkhtmltopdf.org/)
* Python 2.7 or 3.3+

0 comments on commit 72eb6dc

Please sign in to comment.