nbconvert

User Documentation

  • Installation
    • Installing nbconvert
    • Installing Pandoc
    • Installing TeX
      • PDF conversion on a limited TeX environment
  • Using as a command line tool
    • Default output format - HTML
    • Supported output formats
      • HTML
      • LaTeX
      • PDF
      • Reveal.js HTML slideshow
      • Markdown
      • reStructuredText
      • Executable script
      • Notebook and preprocessors
    • Converting multiple notebooks
  • Using nbconvert as a library
  • Quick overview
  • Extracting Figures using the RST Exporter
  • Extracting Figures using the HTML Exporter
  • Some theory
  • Using different preprocessors
  • Custom Preprocessors
  • Example
  • Programatically creating templates
  • Real World Uses
  • LaTeX citations
  • Executing notebooks
    • Executing notebooks from the command line
    • Executing notebooks using the Python API interface
      • Example
    • Execution arguments (traitlets)
    • Handling errors and exceptions
      • Execution until first error
      • Handling errors
      • Execute and save all errors

Configuration

  • Configuration options
  • Customizing nbconvert
  • Template structure
  • A few gotchas
  • Templates that use cell metadata
  • Customizing exporters
    • Extending the built-in format exporters
    • Registering a custom exporter as an entry point
    • Using a custom exporter without entrypoints
  • Parameters controlled by an external exporter
  • Writing a custom Exporter

Developer Documentation

  • Architecture of nbconvert
    • A detailed pipeline exploration
    • Classes
      • Exporters
      • Preprocessors
      • Templates and Filters
      • Writers
      • Postprocessors
  • Python API for working with nbconvert
    • NbConvertApp
    • Exporters
      • Exporter base classes
      • Specialized exporter classes
    • Preprocessors
      • Specialized preprocessors
    • Filters
    • Writers
      • Specialized writers
    • Postprocessors
      • Specialized postprocessors

About nbconvert

  • Changes in nbconvert
    • 5.1.1
    • 5.1
    • 5.0
    • 4.3
    • 4.2
    • 4.1
    • 4.0

Questions? Suggestions?

  • Jupyter mailing list
  • Jupyter website
  • Stack Overflow - Jupyter
  • Stack Overflow - Jupyter-notebook
 
nbconvert
  • Docs »
  • Python Module Index

Python Module Index

n
 
n
- nbconvert
    nbconvert.exporters
    nbconvert.filters
    nbconvert.nbconvertapp
    nbconvert.postprocessors
    nbconvert.preprocessors
    nbconvert.writers

© Copyright 2015-2017, Jupyter Development Team.

Built with Sphinx using a theme provided by Read the Docs.