Skip to content

Commit 1f13f48

Browse files
committed
add favicon and local build instructions
1 parent fef8238 commit 1f13f48

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,24 @@ cd xarray-tutorial
4343
pixi run tutorial
4444
```
4545

46+
### Building the Documentation Locally
47+
48+
To build and serve the tutorial website locally as a development server:
49+
50+
1. Build the Jupyter Book:
51+
```bash
52+
pixi run build
53+
```
54+
55+
2. Serve the built site locally:
56+
```bash
57+
pixi run python -m http.server --directory _build/html
58+
```
59+
60+
Then visit http://localhost:8000 in your browser.
61+
62+
Note: The `build` command does not have live rebuilding. You'll need to re-run `pixi run build` after making changes to see updates.
63+
4664
## Contributing
4765

4866
Contributions are welcome and greatly appreciated! See our [CONTRIBUTING.md](./CONTRIBUTING.md) document.

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ html:
1818
extra_footer: '<p>Xarray is a fiscally sponsored project of <a href="https://numfocus.org">NumFOCUS</a>, a nonprofit dedicated to supporting the open-source scientific computing community.<br> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a>.</p> Content licensed under the terms of the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0 License</a>.'
1919
analytics:
2020
google_analytics_id: G-JRQHYVFQR7
21+
favicon: "images/favicon.ico"
2122

2223
parse:
2324
# https://jupyterbook.org/content/content-blocks.html?highlight=myst%20substitution#define-substitutions-for-your-whole-book

images/favicon.ico

1.23 KB
Binary file not shown.

0 commit comments

Comments
 (0)