From 1f13f482051387f84030e08e7240cfdcb0b58bbd Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Mon, 6 Oct 2025 12:55:56 -0400 Subject: [PATCH 1/2] add favicon and local build instructions --- README.md | 18 ++++++++++++++++++ _config.yml | 1 + images/favicon.ico | Bin 0 -> 1264 bytes 3 files changed, 19 insertions(+) create mode 100644 images/favicon.ico diff --git a/README.md b/README.md index 9ab97996..02506224 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,24 @@ 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.

Content licensed under the terms of the Apache 2.0 License.' 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 diff --git a/images/favicon.ico b/images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..127feadc85fc017d19700878f0e332d4563303a8 GIT binary patch literal 1264 zcmVPx(s!2paRA@u(SWQn8K^UGX0%E0w0Hq|7cr=oTh95wC;NaJRqu%)eoCpWQ?msXQ z6B7e>6GLN+cx?LvRAN%&2NXyZ2_V*hDFoWlncdl)ot@d8EnB6=JvF=2ndf<*=Y8j$ zfuPAB*yQ-Ze*%A7L0<(Pf8R^BATR@b#X`V;3;^5Jqi0in-S@*H?n_{9cON4Q z^Q*^|-0Z-B7RrQvA)DXb&msU)WHC(j1XRk^qkOS?I0_Nc{|EsG_ z`oN1N!nP?^4@PMW8csk7yo#M50Oe!DHmraRB{09cmqh>?o3x z|3d^sqBYn;iVFDH$z>s?YMl-O98bQgHg68#QV9X*IrT{#)IyA6&10c+twU_{XK;?> z9wrlM#Y|HgX0_ACK45m7Cl@PGO6Ien5eG7|O2odR)0}^n{;1J5cT zio89ikpm?12&F_YFV0Srg((4gl&IL;(CM)F;#xQrU$@pzU1vz8TkrYsvj!%_eXb>7^__}b5sc2*(M zfm+~g0%!(bb>f?j-d;QJt=HWu-dFu1{ZQq-TdJkR!DK&2Re*%q*t=h~@ aufQ+iqPI`Lh5WJr0000 Date: Mon, 6 Oct 2025 17:01:43 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 02506224..acf1078b 100644 --- a/README.md +++ b/README.md @@ -48,11 +48,13 @@ pixi run tutorial 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 ```