Skip to content

Commit b4d508b

Browse files
Merge pull request #153 from 00krishna-opensource/create_docs_2
finished initial documentation build
2 parents 956f5af + 00bbeec commit b4d508b

File tree

3 files changed

+593
-0
lines changed

3 files changed

+593
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- 'release-'
8+
tags: '*'
9+
pull_request:
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
- uses: julia-actions/setup-julia@latest
17+
with:
18+
version: '1'
19+
- name: Install dependencies
20+
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
21+
- name: Build and deploy
22+
env:
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
24+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
25+
run: julia --project=docs/ --code-coverage=user docs/make.jl
26+
- uses: julia-actions/julia-processcoverage@v1
27+
- uses: codecov/codecov-action@v1
28+
with:
29+
file: lcov.info

docs/src/finitediff.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# API
2+
3+
```@autodocs
4+
Modules = [FiniteDiff]
5+
```

0 commit comments

Comments
 (0)