Documentation for TeSS Platform

https://elixirtess.github.io/docs/

Separate the training docs/help content to separate repo, like IBISBA Handboook.

Built using Jupyter Book 1. For additional guidance, see:

• Anatomy of a Jupyter Book (TeachBooks.io)
• Sphinx Design (the engine behind Jupyter Book) including CSS classes
• MyST Syntax Extensions even though we are using Markdown, not MyST

Running locally and on GitHub Pages

Requirements:

• Python

To run locally, install Jupyter Book in a virtual environment then build:

python -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
jupyter-book build TeSS_docs/

And when you have finished, to quit virtual environment:

deactivate

We are hosting on GitHub Pages (using Actions), using a different build command that means the .html part of the paths are not included. For example, we have page URLs like https://elixirtess.github.io/docs/accounts/user/ instead of https://elixirtess.github.io/docs/accounts/user.html -- this is achieved by rendering each page as a directory with its own index.html page. When running locally, this doesn't work so well, so use the default build command shown above.

The build command in the GitHub Action includes:

jupyter-book build --builder dirhtml TeSS_docs/

Note

These instructions will change with the release of Jupyter Book 2.