simply-logical / cplint-book-template

A Jupyter Book template for interactive cplint documents

Interactive cplint Book Example

This repository holds a Jupyter Book template for building interactive cplint books based on SWISH. The cplint support is enabled with our custom sphinx-prolog extension. The built book is hosted on GitHub Pages and is available under http://cplint-template.simply-logical.space. This webpage describes the process of building interactive cplint content with the aforementioned technology stack.

Building the Book

1. Pull the book repository

   git clone https://github.com/simply-logical/cplint-book-template.git
   
   cd cplint-book-template

2. Install Jupyter Book with the sphinx-prolog extension

   pip install -r requirements.txt

3. Build the book

   jb build .

4. Open the html build

   open _build/html/index.html

   or run it as a server

   python -m http.server --directory _build/html
   open http://localhost:8000