Skip to content

Commit

Permalink
Updates to Documentation and ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
natgeo-wong committed Sep 8, 2024
1 parent c3f471a commit 100ba27
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 14 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RegionGrids

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://natgeo-wong.github.io/RegionGrids.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://natgeo-wong.github.io/RegionGrids.jl/dev/)
[![Build Status](https://github.com/natgeo-wong/RegionGrids.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/natgeo-wong/RegionGrids.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/natgeo-wong/RegionGrids.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/natgeo-wong/RegionGrids.jl)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://GeoRegionsEcosystem.github.io/RegionGrids.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://GeoRegionsEcosystem.github.io/RegionGrids.jl/dev/)
[![Build Status](https://github.com/natgeo-wong/RegionGrids.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/GeoRegionsEcosystem/RegionGrids.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/natgeo-wong/RegionGrids.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/GeoRegionsEcosystem/RegionGrids.jl)
41 changes: 31 additions & 10 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,23 +1,44 @@
using RegionGrids
using Documenter
using DocumenterVitepress
using RegionGrids
# using CairoMakie
# using Literate

# CairoMakie.activate!(type = "svg")

DocMeta.setdocmeta!(RegionGrids, :DocTestSetup, :(using RegionGrids); recursive=true)

makedocs(;
modules=[RegionGrids],
authors="Nathanael Wong <[email protected]>",
sitename="RegionGrids.jl",
format=Documenter.HTML(;
canonical="https://natgeo-wong.github.io/RegionGrids.jl",
edit_link="main",
assets=String[],
modules = [RegionGrids],
authors = "Nathanael Wong <[email protected]>",
sitename = "RegionGrids.jl",
doctest = false,
warnonly = true,
format = DocumenterVitepress.MarkdownVitepress(
repo = "https://github.com/GeoRegionsEcosystem/RegionGrids.jl",
),
pages=[
"Home" => "index.md",
],
)

recursive_find(directory, pattern) =
mapreduce(vcat, walkdir(directory)) do (root, dirs, files)
joinpath.(root, filter(contains(pattern), files))
end

files = []
for pattern in [r"\.cst", r"\.nc"]
global files = vcat(files, recursive_find(@__DIR__, pattern))
end

for file in files
rm(file)
end

deploydocs(;
repo="github.com/natgeo-wong/RegionGrids.jl",
devbranch="main",
repo = "github.com/GeoRegionsEcosystem/RegionGrids.jl.git",
target = "build", # this is where Vitepress stores its output
devbranch = "main",
branch = "gh-pages",
)

0 comments on commit 100ba27

Please sign in to comment.