Skip to content

Latest commit

 

History

History
11 lines (7 loc) · 1.17 KB

File metadata and controls

11 lines (7 loc) · 1.17 KB

Documentation for BackpropTools

C++ Notebooks as Documentation

This repo contains a Docker container that can run C++ notebooks to create a tutorial that can be run on e.g. Binder but also viewed on e.g. readthedocs.

The Docker container to run the C++ notebooks can be built using ./build.sh and run using ./run_jupyter.sh the only requirement is a working Docker installation.

Sphinx doc

Sphinx uses rst files to create a standard documentation format that can also include jupyter notebooks. Use ./build_sphinx.sh to build the image and ./run_build_sphinx.sh to run the container.