The Turing Way Book
For the main repo (where most of the issues live) please follow this link.
All the text for each chapter lives inside it's own folder in the content/ directory.
Everything else is in the website/. Importantly this includes the figures, which are in the website/assets/figures/ directory.
Configuration
- To change the table of contents (order of the chapters) see the
website/_data/toc.ymlfile. Documentation can be found on the jupyter book website. - Same applies for more general configuration using
website/_config.yml
Deploying
The site is built automatically using these two directories. All of the requirements are specificied in website/requirements.txt.
Locally (Mac / Linux Only)
To install jupyter-book etc.
cd website
pip install -r requirements.txt
If you want to see your local changes on your own computer you'll have to go in the website directory and enter make serve (type make on it's own to see the other options).
cd website
make site && make serve
On Netlify
You'll just need the following settings:
- Base directory:
website - Build command:
make site - Publish directory:
_site
Netlify is smart and will find your requirements.txt to do the install for you :) (ruby and the jekyll are installed too) You can find the build history / logs at - https://app.netlify.com/sites/the-turing-way/deploys
Content Templates
Templates for certain types of content are kept in the templates directory.
Templates include:
case-study-template.ipynb- a template for including interactive case studies in the book
The template should be edited accordingly and moved into it's relevant chapter folder in the content directory.