Skip to content

Commit db5ba4b

Browse files
committed
Explain Jupyter Book 1 is being kept for now
1 parent 4241837 commit db5ba4b

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation for TeSS Platform
22

3-
https://elixirtess.github.io/docs/
3+
<https://elixirtess.github.io/docs/>
44

55
Separate the training docs/help content to separate repo, like [IBISBA Handboook](https://ibisba.github.io/workshop/docs/intro.html).
66

7-
Built using [Jupyter Book 1](https://jupyterbook.org/). For additional guidance, see:
7+
Built using [Jupyter Book 1](https://jupyterbook.org/stable/resources/faq/#faq-general). For additional guidance, see:
88

99
- [Anatomy of a Jupyter Book (TeachBooks.io)](https://teachbooks.io/manual/basic-features/jupyterbook.html)
1010
- [Sphinx Design (the engine behind Jupyter Book)](https://sphinx-design.readthedocs.io/en/latest/) including [CSS classes](https://sphinx-design.readthedocs.io/en/pydata-theme/css_classes.html)
@@ -23,7 +23,6 @@ python -m venv venv
2323
source venv/bin/activate
2424
pip install --upgrade pip
2525
pip install -r requirements.txt
26-
pip install -U jupyter-book
2726
jupyter-book build TeSS_docs/
2827
```
2928

@@ -40,3 +39,6 @@ The build command in the GitHub Action includes:
4039
```shell
4140
jupyter-book build --builder dirhtml TeSS_docs/
4241
```
42+
43+
> [!NOTE]
44+
> These instructions will change with the [release of Jupyter Book 2](https://jupyterbook.org/stable/resources/upgrade/).

0 commit comments

Comments
 (0)