Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,26 @@ cd xarray-tutorial
pixi run tutorial
```

### Building the Documentation Locally

To build and serve the tutorial website locally as a development server:

1. Build the Jupyter Book:

```bash
pixi run build
```

2. Serve the built site locally:

```bash
pixi run python -m http.server --directory _build/html
```

Then visit http://localhost:8000 in your browser.

Note: The `build` command does not have live rebuilding. You'll need to re-run `pixi run build` after making changes to see updates.

## Contributing

Contributions are welcome and greatly appreciated! See our [CONTRIBUTING.md](./CONTRIBUTING.md) document.
Expand Down
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ html:
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>.'
analytics:
google_analytics_id: G-JRQHYVFQR7
favicon: "images/favicon.ico"

parse:
# https://jupyterbook.org/content/content-blocks.html?highlight=myst%20substitution#define-substitutions-for-your-whole-book
Expand Down
Binary file added images/favicon.ico
Binary file not shown.
Loading