https://github.com/jbn/dissertate

Tools for typesetting using Jupyter/IPython notebooks.
https://github.com/jbn/dissertate

ipython ipython-notebook jupyter jupyter-notebook

Last synced: about 2 months ago
JSON representation

Tools for typesetting using Jupyter/IPython notebooks.

• Host: GitHub
• URL: https://github.com/jbn/dissertate
• Owner: jbn
• License: mit
• Created: 2017-04-30T16:24:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-04-29T17:37:55.000Z (over 5 years ago)
• Last Synced: 2024-10-12T15:45:20.270Z (3 months ago)
• Topics: ipython, ipython-notebook, jupyter, jupyter-notebook
• Language: Jupyter Notebook
• Homepage:
• Size: 65.4 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://travis-ci.org/jbn/dissertate.svg?branch=master

    :target: https://travis-ci.org/jbn/dissertate

.. image:: https://ci.appveyor.com/api/projects/status/69kj3prrrieyp8q2/branch/master?svg=true

    :target: https://ci.appveyor.com/project/jbn/dissertate/branch/master 

.. image:: https://coveralls.io/repos/github/jbn/dissertate/badge.svg?branch=master

    :target: https://coveralls.io/github/jbn/dissertate?branch=master 

.. image:: https://img.shields.io/pypi/v/dissertate.svg

    :target: https://pypi.python.org/pypi/dissertate

.. image:: https://img.shields.io/badge/license-MIT-blue.svg

    :target: https://raw.githubusercontent.com/jbn/dissertate/master/LICENSE

.. image:: https://img.shields.io/pypi/pyversions/dissertate.svg

    :target: https://pypi.python.org/pypi/dissertate

Installation

------------

.. code:: sh

   pip install dissertate

Basic Usage

-----------

In ``nb_config.py``,

.. code:: python

   import dissertate

   c = get_config()

   c.Exporter.preprocessors = ['dissertate.preprocessors.CellElider',

                               'dissertate.preprocessors.EmptyCellElider']

   c.Exporter.template_file = dissertate.markdown_template_path()

then,

.. code:: sh

   jupyter nbconvert --config nb_config.py --to markdown your_nb.ipynb

If you don't want a cell in the output, edit the cell metadata to include,

.. code:: json

   {"tags": ["private"]}

Alternatively, you can use

.. code:: json

   {"tags": ["todo"]}

or,

.. code:: json

   {"tags": ["setup"]}

for semantic differences that have no effect on ``dissertate`` processing.

If you want to retain the output of the cell but not the code (e.g.,

for an emitted ``matplotlib`` graph),

.. code:: json

   {"tags": ["output-generator"]}