Skip to content
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

Docs update nov 5 #262

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Docs update nov 5 #262

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
e2809d0
docs update
lmoresi Nov 5, 2024
7047c85
Merge branch 'main' of https://github.com/underworldcode/underworld3
lmoresi Nov 5, 2024
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ The `underworld3` module (API) documentation can be found online:

## Binder demonstration version

Main Branch: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/underworldcode/underworld3/main)
Main Branch: [![Binder](https://mybinder.org/v2/gh/underworld-community/uw3-demo-launcher/HEAD?labpath=underworld3%2Fdocs%2Fuser%2FNotebooks%2FNotebook_Index.ipynb)

Development Branch: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/underworld-community/uw3-demo-launcher/HEAD?labpath=docs%2Fuser%2FNotebooks%2FNotebook_Index.ipynb)
Development Branch: [![Binder](https://mybinder.org/v2/gh/underworld-community/uw3-demo-launcher-dev/HEAD?labpath=underworld3%2Fdocs%2Fuser%2FNotebooks%2FNotebook_Index.ipynb)


## Installation Guide
Expand Down
5 changes: 4 additions & 1 deletion docs/user/_quarto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,15 @@ format:
code-links:
- text: Open in Binder
icon: rocket-takeoff
href: https://mybinder.org/v2/gh/underworldcode/underworld3/development?labpath=WebBook/Notebooks
href: https://mybinder.org/v2/gh/underworld-community/uw3-demo-launcher/HEAD?labpath=underworld3%2Fdocs%2Fuser%2FNotebooks%2FNotebook_Index.ipynb

other-links:
- text: Github Repository
icon: github
href: https://github.com/underworldcode/underworld3
- text: Underworld3 Blog
icon: newspaper
href: https://www.underworlcode.org

# pdf:
# documentclass: scrreprt
Binary file added docs/user/assets/BatPumpkin_255.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/qr-code.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/user/index.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ All `Underworld3` source code is released under the LGPL-3 open source licence.

## Installation Guide

The quickest option is **not to install** anything but click on the rocket icon (top right) to [launch our notebook examples](https://mybinder.org/v2/gh/underworldcode/underworld3/development?labpath=WebBook/Notebooks) on mybinder.org.
The quickest option is **not to install** anything but click on the rocket icon (top right) to [launch our notebook examples](https://mybinder.org/v2/gh/underworld-community/uw3-demo-launcher/HEAD?labpath=underworld3%2Fdocs%2Fuser%2FNotebooks%2FNotebook_Index.ipynb) on mybinder.org.

If do you want to install the code on your own machine, we recommend using `miniconda` and `mamba`. Create a separate virtual environment and install the code from source. More details on how to do that are in the [Installation Instructions](Installation.qmd)

Expand Down
Loading