diff --git a/README.md b/README.md index 9ab97996..acf1078b 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/_config.yml b/_config.yml index ef408d71..45bea26e 100644 --- a/_config.yml +++ b/_config.yml @@ -18,6 +18,7 @@ html: extra_footer: '
Xarray is a fiscally sponsored project of NumFOCUS, a nonprofit dedicated to supporting the open-source scientific computing community.
Theme by the Executable Book Project.