Skip to content

Commit e046199

Browse files
authored
Update README.md
1 parent a4c3398 commit e046199

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,17 @@ Built using [Jupyter Book 1](https://jupyterbook.org/). For additional guidance,
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)
1111
- [MyST Syntax Extensions](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html) even though we are using Markdown, not MyST
1212

13+
## Running locally and on GitHub Pages
14+
1315
To run locally, install Jupyter Book then build:
1416
```shell
1517
pip install -U jupyter-book
1618
jupyter-book build TeSS_docs/
1719
```
20+
21+
We are hosting on GitHub Pages (using [Actions](https://github.com/ElixirTeSS/docs/blob/main/.github/workflows/main.yml)), 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.
22+
23+
The build command in the GitHub Action includes:
24+
```shell
25+
jupyter-book build --builder dirhtml TeSS_docs/
26+
```

0 commit comments

Comments
 (0)