Commit 06f9e62

ianhipre-commit-ci[bot]

and

authored

add favicon and local build instructions (#343)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

1 parent 1ff836d commit 06f9e62Copy full SHA for 06f9e62

File tree

+21

-0

lines changed

+21

-0

lines changed

Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,26 @@ cd xarray-tutorial`
`43`	`43`	`pixi run tutorial`
`44`	`44`	```
`45`	`45`
	`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`	`+`
	`52`	+```bash
	`53`	`+pixi run build`
	`54`	+```
	`55`	`+`
	`56`	`+2. Serve the built site locally:`
	`57`	`+`
	`58`	+```bash
	`59`	`+pixi run python -m http.server --directory _build/html`
	`60`	+```
	`61`	`+`
	`62`	`+Then visit http://localhost:8000 in your browser.`
	`63`	`+`
	`64`	+Note: The `build` command does not have live rebuilding. You'll need to re-run `pixi run build` after making changes to see updates.
	`65`	`+`
`46`	`66`	`## Contributing`
`47`	`67`
`48`	`68`	`Contributions are welcome and greatly appreciated! See our [CONTRIBUTING.md](./CONTRIBUTING.md) document.`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ html:`
`18`	`18`	`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>.'`
`19`	`19`	`analytics:`
`20`	`20`	`google_analytics_id: G-JRQHYVFQR7`
	`21`	`+ favicon: "images/favicon.ico"`
`21`	`22`
`22`	`23`	`parse:`
`23`	`24`	`# https://jupyterbook.org/content/content-blocks.html?highlight=myst%20substitution#define-substitutions-for-your-whole-book`

1.23 KB

Binary file not shown.

Comments

(0)