Skip to content

Commit 44583a0

Browse files
cscherrercscherrer
committed
getting docs set up
1 parent 0a1303c commit 44583a0

11 files changed

+216
-17
lines changed

‎.github/workflows/TagBot.yml

+6-2
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

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
name: CI
22
on:
3-
pull_request:
4-
branches:
5-
- master
63
push:
74
branches:
85
- master
6+
- dev
97
tags: '*'
8+
- pull_request
109
schedule:
11-
- cron: '44 9 16 * *' # run the cron job one time per month
10+
- cron: '44 9 16 * *' # run the cron job one time per month
1211
jobs:
1312
test:
1413
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -18,10 +17,12 @@ jobs:
1817
matrix:
1918
version:
2019
- '1.5'
21-
- '1'
20+
- '1.6'
2221
- 'nightly'
2322
os:
2423
- ubuntu-latest
24+
- macOS-latest
25+
- windows-latest
2526
arch:
2627
- x64
2728
steps:
@@ -40,8 +41,8 @@ jobs:
4041
${{ runner.os }}-test-${{ env.cache-name }}-
4142
${{ runner.os }}-test-
4243
${{ runner.os }}-
43-
- uses: julia-actions/julia-buildpkg@latest
44-
- uses: julia-actions/julia-runtest@latest
44+
- uses: julia-actions/julia-buildpkg@v1
45+
- uses: julia-actions/julia-runtest@v1
4546
- uses: julia-actions/julia-processcoverage@v1
4647
- uses: codecov/codecov-action@v1
4748
with:
@@ -59,6 +60,11 @@ jobs:
5960
using Pkg
6061
Pkg.develop(PackageSpec(path=pwd()))
6162
Pkg.instantiate()'
63+
- run: |
64+
julia --project=docs -e '
65+
using Documenter: doctest
66+
using MeasureTheory
67+
doctest(MeasureTheory)'
6268
- run: julia --project=docs docs/make.jl
6369
env:
6470
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
*.jl.mem
44
.DS_Store
55
/Manifest.toml
6+
/docs/build/
67
/dev/
78
/.history/
89
/.vscode/

‎CITATION.bib

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
@misc{MeasureTheory.jl,
2-
author = {Chad Scherrer},
3-
title = {{MeasureTheory.jl}},
2+
author = {Chad Scherrer <chad.scherrer@gmail.com> and contributors},
3+
title = {MeasureTheory.jl},
44
url = {https://github.com/cscherrer/MeasureTheory.jl},
5-
version = {v0.1.0},
6-
year = {2020},
5+
version = {v0.2.2},
6+
year = {2021},
77
month = {1}
88
}

‎LICENSE

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Copyright (c) 2020 Chad Scherrer
1+
MIT License
2+
3+
Copyright (c) 2020-2021 Chad Scherrer <[email protected]> and contributors
24

35
Permission is hereby granted, free of charge, to any person obtaining a copy
46
of this software and associated documentation files (the "Software"), to deal

‎Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "MeasureTheory"
22
uuid = "eadaa1a4-d27c-401d-8699-e962e1bbc33b"
3-
authors = ["Chad Scherrer"]
3+
authors = ["Chad Scherrer <[email protected]> and contributors"]
44
version = "0.2.2"
55

66
[deps]

‎README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# MeasureTheory
22

3-
[![Build Status](https://travis-ci.com/cscherrer/MeasureTheory.jl.svg?branch=master)](https://travis-ci.com/cscherrer/MeasureTheory.jl)
4-
[![Codecov](https://codecov.io/gh/cscherrer/MeasureTheory.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/cscherrer/MeasureTheory.jl)
3+
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://cscherrer.github.io/MeasureTheory.jl/stable)
4+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://cscherrer.github.io/MeasureTheory.jl/dev)
5+
[![Build Status](https://github.com/cscherrer/MeasureTheory.jl/workflows/CI/badge.svg)](https://github.com/cscherrer/MeasureTheory.jl/actions)
6+
[![Coverage](https://codecov.io/gh/cscherrer/MeasureTheory.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/cscherrer/MeasureTheory.jl)
57

68
`MeasureTheory.jl` is a package for building and reasoning about measures.
79

‎docs/Manifest.toml

+148
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# This file is machine-generated - editing it directly is not advised
2+
3+
[[ArgTools]]
4+
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
5+
6+
[[Artifacts]]
7+
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
8+
9+
[[Base64]]
10+
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
11+
12+
[[Dates]]
13+
deps = ["Printf"]
14+
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
15+
16+
[[DocStringExtensions]]
17+
deps = ["LibGit2", "Markdown", "Pkg", "Test"]
18+
git-tree-sha1 = "50ddf44c53698f5e784bbebb3f4b21c5807401b1"
19+
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
20+
version = "0.8.3"
21+
22+
[[Documenter]]
23+
deps = ["Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
24+
git-tree-sha1 = "b7715ae18be02110a8cf9cc8ed2ccdb1e3e3aba2"
25+
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
26+
version = "0.26.1"
27+
28+
[[Downloads]]
29+
deps = ["ArgTools", "LibCURL", "NetworkOptions"]
30+
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
31+
32+
[[IOCapture]]
33+
deps = ["Logging"]
34+
git-tree-sha1 = "377252859f740c217b936cebcd918a44f9b53b59"
35+
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
36+
version = "0.1.1"
37+
38+
[[InteractiveUtils]]
39+
deps = ["Markdown"]
40+
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
41+
42+
[[JSON]]
43+
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
44+
git-tree-sha1 = "81690084b6198a2e1da36fcfda16eeca9f9f24e4"
45+
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
46+
version = "0.21.1"
47+
48+
[[LibCURL]]
49+
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
50+
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
51+
52+
[[LibCURL_jll]]
53+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
54+
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
55+
56+
[[LibGit2]]
57+
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
58+
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
59+
60+
[[LibSSH2_jll]]
61+
deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
62+
uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
63+
64+
[[Libdl]]
65+
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
66+
67+
[[Logging]]
68+
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
69+
70+
[[Markdown]]
71+
deps = ["Base64"]
72+
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
73+
74+
[[MbedTLS_jll]]
75+
deps = ["Artifacts", "Libdl"]
76+
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
77+
78+
[[MeasureTheory]]
79+
path = ".."
80+
uuid = "a0f6e684-35f2-45d9-b328-01fa192822dd"
81+
version = "0.1.0"
82+
83+
[[Mmap]]
84+
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
85+
86+
[[MozillaCACerts_jll]]
87+
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
88+
89+
[[NetworkOptions]]
90+
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
91+
92+
[[Parsers]]
93+
deps = ["Dates"]
94+
git-tree-sha1 = "50c9a9ed8c714945e01cd53a21007ed3865ed714"
95+
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
96+
version = "1.0.15"
97+
98+
[[Pkg]]
99+
deps = ["Artifacts", "Dates", "Downloads", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs"]
100+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
101+
102+
[[Printf]]
103+
deps = ["Unicode"]
104+
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
105+
106+
[[REPL]]
107+
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
108+
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
109+
110+
[[Random]]
111+
deps = ["Serialization"]
112+
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
113+
114+
[[SHA]]
115+
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
116+
117+
[[Serialization]]
118+
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
119+
120+
[[Sockets]]
121+
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
122+
123+
[[TOML]]
124+
deps = ["Dates"]
125+
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
126+
127+
[[Tar]]
128+
deps = ["ArgTools", "SHA"]
129+
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
130+
131+
[[Test]]
132+
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
133+
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
134+
135+
[[UUIDs]]
136+
deps = ["Random", "SHA"]
137+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
138+
139+
[[Unicode]]
140+
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
141+
142+
[[Zlib_jll]]
143+
deps = ["Libdl"]
144+
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
145+
146+
[[nghttp2_jll]]
147+
deps = ["Artifacts", "Libdl"]
148+
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"

‎docs/Project.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
MeasureTheory = "a0f6e684-35f2-45d9-b328-01fa192822dd"

‎docs/make.jl

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
using MeasureTheory
2+
using Documenter
3+
4+
makedocs(;
5+
modules=[MeasureTheory],
6+
authors="Chad Scherrer <[email protected]> and contributors",
7+
repo="https://github.com/cscherrer/MeasureTheory.jl/blob/{commit}{path}#L{line}",
8+
sitename="MeasureTheory.jl",
9+
format=Documenter.HTML(;
10+
prettyurls=get(ENV, "CI", "false") == "true",
11+
canonical="https://cscherrer.github.io/MeasureTheory.jl",
12+
assets=String[],
13+
),
14+
pages=[
15+
"Home" => "index.md",
16+
],
17+
)
18+
19+
deploydocs(;
20+
repo="github.com/cscherrer/MeasureTheory.jl",
21+
)

‎docs/src/index.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
```@meta
2+
CurrentModule = MeasureTheory
3+
```
4+
5+
# MeasureTheory
6+
7+
```@index
8+
```
9+
10+
```@autodocs
11+
Modules = [MeasureTheory]
12+
```

0 commit comments

Comments
 (0)