Skip to content

Commit 7109902

Browse files
authored
Implement Documenter documentation pages (#58)
* Add Documenter * Create basic Hello World template * Add GitHub Action and deployment * Bump Julia version for compat with Meshes * Update main page * Bump patch version
1 parent feb56fd commit 7109902

File tree

5 files changed

+44
-1
lines changed

5 files changed

+44
-1
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags: '*'
8+
pull_request:
9+
10+
jobs:
11+
build:
12+
permissions:
13+
actions: write
14+
contents: write
15+
pull-requests: read
16+
statuses: write
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
- uses: julia-actions/setup-julia@v2
21+
with:
22+
version: '1.9'
23+
- uses: julia-actions/cache@v1
24+
- name: Install dependencies
25+
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
26+
- name: Build and deploy
27+
env:
28+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
29+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
30+
run: julia --project=docs/ docs/make.jl

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "MeshIntegrals"
22
uuid = "dadec2fd-bbe0-4da4-9dbe-476c782c8e47"
33
authors = ["Mike Ingold <[email protected]>"]
4-
version = "0.13.0"
4+
version = "0.13.1"
55

66
[deps]
77
CoordRefSystems = "b46f11dc-f210-4604-bfba-323c1ec968cb"

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
MeshIntegrals = "dadec2fd-bbe0-4da4-9dbe-476c782c8e47"

docs/make.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
using Documenter
2+
using MeshIntegrals
3+
4+
makedocs(sitename="MeshIntegrals.jl Documentation")
5+
6+
deploydocs(repo = "github.com/mikeingold/MeshIntegrals.jl.git")

docs/src/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# MeshIntegrals.jl
2+
3+
**MeshIntegrals.jl** is a Julia library that leverages differential forms to implement fast
4+
and easy numerical integration of field equations over geometric domains.

0 commit comments

Comments
 (0)