TeachBooks Documentation: Welcome!

This Python package is primarily a wrapper around the Jupyter Book package and is designed to facilitate usage of the platform in educational contexts. In this case “wrapper” refers to the CLI usage: CLI commands generally invoke jupyter-book commands internally; the jupyter-book package is _not_ distributed within the teachbooks package.

The source code and function of the package is documented on this website. Visit the TeachBooks website and dedicated Manual page to learn more about how this package is used in an educational context.

Contents

Contents:

• Introduction to TeachBooks
  • Conventional Usage
  • Features
  • Installation
• Command Line interface
  • teachbooks
• Internal Components
  • teachbooks.release module
  • teachbooks.serve module
• External content from GitHub/GitLab
  • Example
  • Configuration
  • Notes
• Contributing to TeachBooks
  • You have a question
  • You think you may have found a bug
  • You want to make some kind of change to the code base
  • Set up a development environment
  • Use a development environment
  • You want to make a release
  • Releases and Versioning
• Tests