Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit c5e93ca

Browse files
committed
Add docs
1 parent a87e10c commit c5e93ca

File tree

11 files changed

+331
-241
lines changed

11 files changed

+331
-241
lines changed

‎.appveyor.yml‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎.github/workflows/CompatHelper.yml‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,24 @@ name: CompatHelper
22

33
on:
44
schedule:
5-
- cron: '00 00 * * *'
5+
- cron: '00 * * * *'
66

77
jobs:
88
CompatHelper:
9-
runs-on: ubuntu-latest
9+
runs-on: ${{ matrix.os }}
10+
strategy:
11+
matrix:
12+
julia-version: [1.3]
13+
julia-arch: [x86]
14+
os: [ubuntu-latest]
1015
steps:
1116
- uses: julia-actions/setup-julia@latest
1217
with:
13-
version: 1.3
18+
version: ${{ matrix.julia-version }}
1419
- name: Pkg.add("CompatHelper")
1520
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
1621
- name: CompatHelper.main()
1722
env:
1823
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24+
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
1925
run: julia -e 'using CompatHelper; CompatHelper.main()'

‎.github/workflows/TagBot.yml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
name: TagBot
22
on:
3-
schedule:
4-
- cron: 0 * * * *
3+
issue_comment:
4+
types:
5+
- created
6+
workflow_dispatch:
57
jobs:
68
TagBot:
9+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
710
runs-on: ubuntu-latest
811
steps:
912
- uses: JuliaRegistries/TagBot@v1
1013
with:
1114
token: ${{ secrets.GITHUB_TOKEN }}
15+
ssh: ${{ secrets.DOCUMENTER_KEY }}

‎.github/workflows/ci.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: CI
2+
on:
3+
pull_request:
4+
branches:
5+
- master
6+
paths-ignore:
7+
- 'LICENSE.md'
8+
- 'README.md'
9+
- '.github/workflows/TagBot.yml'
10+
push:
11+
branches:
12+
- master
13+
tags: '*'
14+
paths-ignore:
15+
- 'LICENSE.md'
16+
- 'README.md'
17+
- '.github/workflows/TagBot.yml'
18+
jobs:
19+
test:
20+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
21+
runs-on: ${{ matrix.os }}
22+
strategy:
23+
fail-fast: false
24+
matrix:
25+
version:
26+
- '1.2'
27+
- '1'
28+
- 'nightly'
29+
os:
30+
- ubuntu-latest
31+
arch:
32+
- x64
33+
steps:
34+
- uses: actions/checkout@v2
35+
- uses: julia-actions/setup-julia@v1
36+
with:
37+
version: ${{ matrix.version }}
38+
arch: ${{ matrix.arch }}
39+
- uses: actions/cache@v1
40+
env:
41+
cache-name: cache-artifacts
42+
with:
43+
path: ~/.julia/artifacts
44+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
45+
restore-keys: |
46+
${{ runner.os }}-test-${{ env.cache-name }}-
47+
${{ runner.os }}-test-
48+
${{ runner.os }}-
49+
- uses: julia-actions/julia-buildpkg@v1
50+
- uses: julia-actions/julia-runtest@v1
51+
- uses: julia-actions/julia-processcoverage@v1
52+
- uses: codecov/codecov-action@v1
53+
with:
54+
file: lcov.info
55+
docs:
56+
name: Documentation
57+
runs-on: ubuntu-latest
58+
steps:
59+
- uses: actions/checkout@v2
60+
- uses: julia-actions/setup-julia@v1
61+
with:
62+
version: '1'
63+
- run: |
64+
julia --project=docs -e '
65+
using Pkg
66+
Pkg.develop(PackageSpec(path=pwd()))
67+
Pkg.instantiate()'
68+
- run: |
69+
julia --project=docs -e '
70+
import Documenter: doctest, DocMeta
71+
using LegendrePolynomials
72+
DocMeta.setdocmeta!(LegendrePolynomials, :DocTestSetup, :(using LegendrePolynomials); recursive=true)
73+
doctest(LegendrePolynomials)'
74+
- run: julia --project=docs docs/make.jl
75+
env:
76+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
77+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Manifest.toml
2+
docs/build
3+
docs/Manifest.toml

‎.travis.yml‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎Project.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
name = "LegendrePolynomials"
22
uuid = "3db4a2ba-fc88-11e8-3e01-49c72059a882"
3-
version = "0.2.3"
3+
version = "0.2.4"
44

55
[deps]
66
HyperDualNumbers = "50ceba7f-c3ee-5a84-a6e8-3ad40456ec97"
77
OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
88

99
[compat]
1010
HyperDualNumbers = "4"
11-
OffsetArrays = "0.11, 1.0"
11+
OffsetArrays = "0.11, 1"
1212
julia = "1"

‎docs/Project.toml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
LegendrePolynomials = "3db4a2ba-fc88-11e8-3e01-49c72059a882"
4+
5+
[compat]
6+
Documenter = "0.26"

‎docs/make.jl‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using LegendrePolynomials
2+
using Documenter
3+
4+
DocMeta.setdocmeta!(LegendrePolynomials, :DocTestSetup, :(using LegendrePolynomials); recursive=true)
5+
6+
makedocs(;
7+
modules=[LegendrePolynomials],
8+
authors="Jishnu Bhattacharya",
9+
repo="https://github.com/jishnub/LegendrePolynomials.jl/blob/{commit}{path}#L{line}",
10+
sitename="LegendrePolynomials",
11+
format=Documenter.HTML(;
12+
prettyurls=get(ENV, "CI", "false") == "true",
13+
canonical="https://jishnub.github.io/LegendrePolynomials.jl",
14+
assets=String[],
15+
),
16+
pages=[
17+
"Reference" => "index.md",
18+
],
19+
)
20+
21+
deploydocs(;
22+
repo="github.com/jishnub/LegendrePolynomials.jl",
23+
)

‎docs/src/index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
```@meta
2+
CurrentModule = LegendrePolynomials
3+
```
4+
5+
# LegendrePolynomials.jl
6+
7+
```@autodocs
8+
Modules = [LegendrePolynomials]
9+
```

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /