Skip to content

Commit ab6b531

Browse files
authored
Merge pull request #840 from rafaqz/la/docs_fixes
fix features links
2 parents b89b0b6 + 01f0577 commit ab6b531

File tree

2 files changed

+17
-24
lines changed

2 files changed

+17
-24
lines changed

.github/workflows/Documenter.yml

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,45 @@
1-
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2-
#
3-
name: Documenter
1+
name: Documentation
42

53
on:
6-
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7-
# using the `master` branch as the default branch.
84
push:
95
branches:
106
- main
11-
tags: ['*']
7+
tags: '*'
128
pull_request:
139

14-
# Allows you to run this workflow manually from the Actions tab
15-
workflow_dispatch:
16-
17-
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
10+
# Sets permissions of the GITHUB_TOKEN
1811
permissions:
1912
contents: write
2013
pages: write
2114
id-token: write
2215
statuses: write
2316

24-
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
25-
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
2617
concurrency:
2718
group: pages
28-
cancel-in-progress: false
19+
cancel-in-progress: true
2920

3021
jobs:
31-
# Build job
3222
build:
3323
runs-on: ubuntu-latest
24+
env:
25+
DISPLAY: ':0'
3426
steps:
3527
- name: Checkout
3628
uses: actions/checkout@v4
3729
- name: Setup Julia
38-
uses: julia-actions/setup-julia@v1
30+
uses: julia-actions/setup-julia@v2
3931
- name: Pull Julia cache
40-
uses: julia-actions/cache@v1
41-
- name: Install documentation dependencies
42-
run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
43-
- name: Install custom documentation dependencies
44-
run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()'
32+
uses: julia-actions/cache@v2
33+
- name: Install GLMakie dependencies
34+
run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
35+
- name: Install Julia dependencies
36+
run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs -e 'using Pkg; Pkg.Registry.update(); pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()'
4537
- name: Build and deploy
4638
env:
4739
RASTERDATASOURCES_PATH: "."
48-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
49-
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
50-
GKSwstype: "100" # https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988
40+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
42+
GKSwstype: "100"
5143
JULIA_DEBUG: "Documenter"
5244
DATADEPS_ALWAYS_ACCEPT: true
5345
run: |

docs/src/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ hero:
2424
features:
2525
- title: Rasters.jl
2626
details: Defines common types and methods for reading, writing and manipulating rasterized spatial data.
27-
link: /markdown-examples
27+
link: /methods
2828
- title: Data Formats
2929
details: These currently include raster arrays like <strong>GeoTIF</strong> and <strong>NetCDF</strong>, <strong>R grd</strong> files, multi-layered stacks, and multi-file series of arrays and stacks.
30+
link: /data_sources
3031
---
3132
```
3233

0 commit comments

Comments
 (0)