Documentation for poli and poli-baselines 🧪

This repository contains a jupyter-book with documentation for poli and poli-baselines

Building the documentation

The folder ./docs/poli-docs is a Jupyter Book. To build it, create a new environment (python>=3.9) and install the requirements:

conda create -n poli-docs python=3.9
conda activate poli-docs
pip install -r requirements.txt

Building

After this, you can build the documentation using

jupyter-book build --all docs/poli-docs

Deployment

Since we are relying on building the website locally (because of foldx dependencies), you will need to

1. pip install ghp-import
2. run ghp-import -n -p -f ./docs/poli-docs/_build/html