From ce24d1c0932b724ad45c2f66eb0487c3894496fa Mon Sep 17 00:00:00 2001 From: Julius Busecke <4314623+jbusecke@users.noreply.github.com> Date: Thu, 5 Feb 2026 17:24:21 -0500 Subject: [PATCH] Add local docs build instructions + add footer github icon --- README.md | 31 +++++++++++++++++++++++++++++++ docs/conf.py | 10 ++++++++++ 2 files changed, 41 insertions(+) diff --git a/README.md b/README.md index 0ffeb12..862f444 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,34 @@ Our intent is to provide reusable building blocks for the many sub-ecosystems ar ``` pip install rasterix ``` + +## Building Documentation Locally + +Install the package with documentation dependencies: + +``` +pip install -e ".[docs]" +``` + +Build the HTML docs: + +``` +cd docs +make html +``` + +Open `docs/_build/html/index.html` in your browser to view the result. + +For a live-reload development server that rebuilds on changes: + +``` +cd docs +make livehtml +``` + +To also open the docs in your browser automatically: + +``` +cd docs +make livehtml SPHINXOPTS="--open-browser" +``` diff --git a/docs/conf.py b/docs/conf.py index b51d9bd..8061260 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -119,6 +119,16 @@ sidebar_hide_name=False, light_css_variables=css_vars, dark_css_variables=css_vars, + source_repository="https://github.com/xarray-contrib/rasterix", + source_branch="main", + source_directory="/docs", + footer_icons=[ + { + "name": "GitHub", + "url": "https://github.com/xarray-contrib/rasterix", + "html": '', + }, + ], ) html_context = {