Documentation for nbdime – tools for diffing and merging of Jupyter Notebooks

NB! The nbdime project and this documentation and is in a very early stage of development and is not usable for any kind of production work yet.

Contents:

• Overview of nbdime project
• Installing and testing nbdime
  • Dependencies
  • Install
  • Testing
• Commandline interface
• Description of the diff representation in nbdime
  • Diff format basics
  • Diff format for mappings
  • Diff format for sequences (list and string)
  • Relation to JSONPatch
  • Examples
• Representing merge results and conflicts
• Notebook specific issues
• Use cases and future development plans
  • Basic diffing use cases
  • Version control use cases
  • Regression testing use cases

Indices and tables

• Index
• Module Index
• Search Page