Skip to content

Add local docs build instructions + add footer github icon #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jbusecke wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add local docs build instructions + add footer github icon #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce24d1c
Add local docs build instructions + add footer github icon
bmcgough Feb 5, 2026
9e5b50d
Merge branch 'main' into docs-guide-and-github-button
jbusecke Feb 5, 2026
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
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
9 changes: 8 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,16 @@
sidebar_hide_name=False,
light_css_variables=css_vars,
dark_css_variables=css_vars,
top_of_page_buttons=["view"],
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",
Copy link
Copy Markdown
Contributor

@dcherian dcherian Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://pradyunsg.me/furo/customisation/footer/#default-icons?

"html": '<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg>',
},
],
)

html_context = {
Expand Down
Loading