Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.64 KB

README.md

File metadata and controls

36 lines (24 loc) · 1.64 KB
Raw

The Turing Way Pathway Feature - Python Package

The package in this repo is developed on, where this repo is forked from: https://github.com/alan-turing-institute/bio-Turing-Way/

This is a repo for exploring ways to deploy multiple pathways for the Turing Way Jupyter Book. The goal is:

  1. Maintain a main book, which contains the entire book.
  2. There will be multiple pathways which are sets of Turing Way pages which are selected for specific audiences. For example the pages about Reproducibility and Communication may be selected for the DSG pathway. Project Design pages may be selected for the Group-Leader pathway.
  3. We are trying to find a way to deploy multiple pathways, OR to enable access to pathways with good user experience.

The deploy branch's master folder is the work that deploys to Netlify.

My Jupyter Book

Codestyle Black

Instructions

Install

  1. Clone the source code with git clone git@github.com:Iain-S/my_jupyter_book.git
  2. Change to the source code directory with cd my_jupyter_book
  3. Set Python 3.8 as the local version to use with pyenv local 3.8.12
  4. Make a Python 3.8 virtual environment with virtualenv venv
  5. Activate it with source venv/bin/activate
  6. Install pre-commit hooks with pre-commit install

Run

  1. Build our example book with jupyter-book build mynewbook
  2. Build our other editions with python -m main build mynewbook
  3. Change to the html directory with cd mynewbook/_build/html
  4. Serve it (for development) with python -m http.server