Skip to main content

A package and CLI for writing dissertations.

Project description

https://travis-ci.org/jbn/dissertate.svg?branch=master https://ci.appveyor.com/api/projects/status/69kj3prrrieyp8q2/branch/master?svg=true https://coveralls.io/repos/github/jbn/dissertate/badge.svg?branch=master https://img.shields.io/pypi/v/dissertate.svg https://img.shields.io/badge/license-MIT-blue.svg https://img.shields.io/pypi/pyversions/dissertate.svg

Installation

pip install dissertate

Basic Usage

In nb_config.py,

import dissertate

c = get_config()

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

c.Exporter.template_file = dissertate.markdown_template_path()

then,

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,

{"tags": ["private"]}

Alternatively, you can use

{"tags": ["todo"]}

or,

{"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),

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dissertate-0.0.9.tar.gz (6.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page