Skip to content

Commit 73d1815

Browse files
committed
Prototype docs structure (nothing here yet)
1 parent 1031be1 commit 73d1815

File tree

6 files changed

+46
-0
lines changed

6 files changed

+46
-0
lines changed

docs/make.jl

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#! /usr/bin/env julia
2+
3+
using Documenter
4+
5+
using GeometryBasics
6+
7+
# Copy the README to serve as the homepage
8+
cp(joinpath(@__DIR__, "..", "README.md"), joinpath(@__DIR__, "src", "index.md"))
9+
10+
makedocs(
11+
format = Documenter.HTML(),
12+
sitename = "GeometryBasics.jl",
13+
pages = [
14+
"index.md",
15+
"rectangles.md",
16+
"polygons.md",
17+
"meshes.md",
18+
"api.md",
19+
],
20+
modules = [GeometryTypes]
21+
)
22+
23+
deploydocs(
24+
repo = "github.com/JuliaGeometry/GeometryTypes.jl.git",
25+
push_preview = true
26+
)

docs/src/api.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# API Reference
2+
3+
```@autodocs
4+
Modules = [GeometryBasics]
5+
Order = [:module, :constant, :type, :function, :macro]
6+
Public = true
7+
Private = false
8+
```
9+
10+
## What isn't
11+
12+
```@autodocs
13+
Modules = [GeometryBasics]
14+
Order = [:module, :constant, :type, :function, :macro]
15+
Public = false
16+
Private = true
17+
```

docs/src/decomposition.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Decomposition

docs/src/meshes.md

Whitespace-only changes.

docs/src/polygons.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Polygons

docs/src/rectangles.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Rectangles

0 commit comments

Comments
 (0)