Skip to content

rl-tools/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation for RLtools

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. To update the documentation container replace the commit hash in the Dockerfile.

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.

Deploy

cp -r _build/html/* static/