Skip to content
This repository was archived by the owner on Sep 28, 2024. It is now read-only.

Commit 75439a5

Browse files
foldfelisfoldfelis
committed
add doc and ci
1 parent fba4619 commit 75439a5

File tree

5 files changed

+201
-0
lines changed

5 files changed

+201
-0
lines changed

‎.github/workflows/CI.yml‎

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

‎docs/Manifest.toml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# This file is machine-generated - editing it directly is not advised
2+
3+
[[ANSIColoredPrinters]]
4+
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
5+
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
6+
version = "0.0.1"
7+
8+
[[Base64]]
9+
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
10+
11+
[[Dates]]
12+
deps = ["Printf"]
13+
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
14+
15+
[[DocStringExtensions]]
16+
deps = ["LibGit2"]
17+
git-tree-sha1 = "a32185f5428d3986f47c2ab78b1f216d5e6cc96f"
18+
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
19+
version = "0.8.5"
20+
21+
[[Documenter]]
22+
deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
23+
git-tree-sha1 = "350dced36c11f794c6c4da5dc6493ec894e50c16"
24+
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
25+
version = "0.27.5"
26+
27+
[[IOCapture]]
28+
deps = ["Logging", "Random"]
29+
git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
30+
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
31+
version = "0.2.2"
32+
33+
[[InteractiveUtils]]
34+
deps = ["Markdown"]
35+
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
36+
37+
[[JSON]]
38+
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
39+
git-tree-sha1 = "8076680b162ada2a031f707ac7b4953e30667a37"
40+
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
41+
version = "0.21.2"
42+
43+
[[LibGit2]]
44+
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
45+
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
46+
47+
[[Logging]]
48+
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
49+
50+
[[Markdown]]
51+
deps = ["Base64"]
52+
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
53+
54+
[[Mmap]]
55+
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
56+
57+
[[NetworkOptions]]
58+
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
59+
60+
[[NeuralOperators]]
61+
path = ".."
62+
uuid = "9ab867d4-5049-4b07-85bc-95379d8d6d9c"
63+
version = "0.1.0"
64+
65+
[[Parsers]]
66+
deps = ["Dates"]
67+
git-tree-sha1 = "477bf42b4d1496b454c10cce46645bb5b8a0cf2c"
68+
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
69+
version = "2.0.2"
70+
71+
[[Printf]]
72+
deps = ["Unicode"]
73+
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
74+
75+
[[REPL]]
76+
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
77+
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
78+
79+
[[Random]]
80+
deps = ["Serialization"]
81+
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
82+
83+
[[SHA]]
84+
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
85+
86+
[[Serialization]]
87+
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
88+
89+
[[Sockets]]
90+
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
91+
92+
[[Test]]
93+
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
94+
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
95+
96+
[[Unicode]]
97+
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

‎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+
NeuralOperators = "9ab867d4-5049-4b07-85bc-95379d8d6d9c"

‎docs/make.jl‎

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

‎docs/src/index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
```@meta
2+
CurrentModule = NeuralOperators
3+
```
4+
5+
# NeuralOperators
6+
7+
Documentation for [NeuralOperators](https://github.com/foldfelis/NeuralOperators.jl).
8+
9+
```@index
10+
```
11+
12+
```@autodocs
13+
Modules = [NeuralOperators]
14+
```

0 commit comments

Comments
 (0)