Skip to content

Commit ae4c138

Browse files
committed
Start docs
1 parent 139fee6 commit ae4c138

File tree

4 files changed

+46
-0
lines changed

4 files changed

+46
-0
lines changed

.github/documentation.yml

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

docs/Project.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
4+
[compat]
5+
Documenter = "0.27"

docs/make.jl

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
using Documenter, ClassicalOrthogonalPolynomials
2+
3+
makedocs(
4+
modules = [ClassicalOrthogonalPolynomials],
5+
sitename="ClassicalOrthogonalPolynomials.jl",
6+
pages = Any[
7+
"Home" => "index.md"])
8+
9+
deploydocs(
10+
repo = "github.com/JuliaApproximation/ClassicalOrthogonalPolynomials.jl.git",
11+
)

docs/src/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# ClassicalOrthogonalPolynomials.jl
2+
3+
*Classical orthogonal polynomials in Julia*
4+

0 commit comments

Comments
 (0)