Skip to content

Commit 68b66df

Browse files
CarloLucibelloCarloLucibello
committed
Fixes for Documenter
1 parent e43c307 commit 68b66df

File tree

6 files changed

+198
-31
lines changed

6 files changed

+198
-31
lines changed

‎.travis.yml

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,17 @@ addons:
1919
apt: # apt-get for linux
2020
packages:
2121
- hdf5-tools
22-
22+
2323
jobs:
2424
include:
25-
- stage: deploy
26-
julia: 1.2
25+
- stage: "Documentation"
26+
julia: 1.0
2727
os: linux
2828
script:
29-
- julia -e 'import Pkg; Pkg.clone(pwd()); Pkg.build("MLDatasets")'
30-
- julia -e 'import Pkg; ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
31-
- julia -e 'import MLDatasets; ENV["DOCUMENTER_DEBUG"] = "true"; include(joinpath("docs","make.jl"))'
32-
33-
## uncomment the following lines to override the default test script
34-
#script:
35-
# - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
36-
# - julia --check-bounds=yes --color=yes -e 'import Pkg; Pkg.clone(pwd()); Pkg.build("MLDatasets"); Pkg.test("MLDatasets"; coverage=true)';
29+
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
30+
Pkg.instantiate()'
31+
- julia --project=docs/ docs/make.jl
32+
after_success: skip
3733

3834
after_success:
3935
- julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder())'

‎docs/Manifest.toml

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# This file is machine-generated - editing it directly is not advised
2+
3+
[[Base64]]
4+
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
5+
6+
[[BinDeps]]
7+
deps = ["Compat", "Libdl", "SHA", "URIParser"]
8+
git-tree-sha1 = "12093ca6cdd0ee547c39b1870e0c9c3f154d9ca9"
9+
uuid = "9e28174c-4ba2-5203-b857-d8d62c4213ee"
10+
version = "0.8.10"
11+
12+
[[BinaryProvider]]
13+
deps = ["Libdl", "Logging", "SHA"]
14+
git-tree-sha1 = "c7361ce8a2129f20b0e05a89f7070820cfed6648"
15+
uuid = "b99e7846-7c00-51b0-8f62-c81ae34c0232"
16+
version = "0.5.6"
17+
18+
[[ColorTypes]]
19+
deps = ["FixedPointNumbers", "Random"]
20+
git-tree-sha1 = "10050a24b09e8e41b951e9976b109871ce98d965"
21+
uuid = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
22+
version = "0.8.0"
23+
24+
[[Compat]]
25+
deps = ["Base64", "Dates", "DelimitedFiles", "Distributed", "InteractiveUtils", "LibGit2", "Libdl", "LinearAlgebra", "Markdown", "Mmap", "Pkg", "Printf", "REPL", "Random", "Serialization", "SharedArrays", "Sockets", "SparseArrays", "Statistics", "Test", "UUIDs", "Unicode"]
26+
git-tree-sha1 = "84aa74986c5b9b898b0d1acaf3258741ee64754f"
27+
uuid = "34da2185-b29b-5c13-b0c7-acf172513d20"
28+
version = "2.1.0"
29+
30+
[[DataDeps]]
31+
deps = ["HTTP", "Reexport", "SHA"]
32+
git-tree-sha1 = "3b07400b34d0a993d13370a179877cfd218d1d17"
33+
uuid = "124859b0-ceae-595e-8997-d05f6a7a8dfe"
34+
version = "0.7.0"
35+
36+
[[Dates]]
37+
deps = ["Printf"]
38+
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
39+
40+
[[DelimitedFiles]]
41+
deps = ["Mmap"]
42+
uuid = "8bb1440f-4735-579b-a4ab-409b98df4dab"
43+
44+
[[Distributed]]
45+
deps = ["Random", "Serialization", "Sockets"]
46+
uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
47+
48+
[[FixedPointNumbers]]
49+
git-tree-sha1 = "d14a6fa5890ea3a7e5dcab6811114f132fec2b4b"
50+
uuid = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
51+
version = "0.6.1"
52+
53+
[[GZip]]
54+
deps = ["Libdl", "Test"]
55+
git-tree-sha1 = "ee443ef166b29282301468d8af403e1ed8f5412e"
56+
uuid = "92fee26a-97fe-5a0c-ad85-20a5f3185b63"
57+
version = "0.5.0"
58+
59+
[[HTTP]]
60+
deps = ["Base64", "Dates", "IniFile", "MbedTLS", "Sockets"]
61+
git-tree-sha1 = "f1e1b417a34cf73a70cbed919915bf8f8bad1806"
62+
uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3"
63+
version = "0.8.6"
64+
65+
[[IniFile]]
66+
deps = ["Test"]
67+
git-tree-sha1 = "098e4d2c533924c921f9f9847274f2ad89e018b8"
68+
uuid = "83e8ac13-25f8-5344-8a64-a9f2b223428f"
69+
version = "0.5.0"
70+
71+
[[InteractiveUtils]]
72+
deps = ["Markdown"]
73+
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
74+
75+
[[LibGit2]]
76+
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
77+
78+
[[Libdl]]
79+
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
80+
81+
[[LinearAlgebra]]
82+
deps = ["Libdl"]
83+
uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
84+
85+
[[Logging]]
86+
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
87+
88+
[[MLDatasets]]
89+
deps = ["BinDeps", "ColorTypes", "DataDeps", "FixedPointNumbers", "GZip", "Requires"]
90+
path = "/home/carlo/.julia/dev/MLDatasets"
91+
uuid = "eb30cadb-4394-5ae3-aed4-317e484a6458"
92+
version = "0.4.0"
93+
94+
[[Markdown]]
95+
deps = ["Base64"]
96+
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
97+
98+
[[MbedTLS]]
99+
deps = ["BinaryProvider", "Dates", "Libdl", "Random", "Sockets"]
100+
git-tree-sha1 = "85f5947b53c8cfd53ccfa3f4abae31faa22c2181"
101+
uuid = "739be429-bea8-5141-9913-cc70e7f3736d"
102+
version = "0.7.0"
103+
104+
[[Mmap]]
105+
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
106+
107+
[[Pkg]]
108+
deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
109+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
110+
111+
[[Printf]]
112+
deps = ["Unicode"]
113+
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
114+
115+
[[REPL]]
116+
deps = ["InteractiveUtils", "Markdown", "Sockets"]
117+
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
118+
119+
[[Random]]
120+
deps = ["Serialization"]
121+
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
122+
123+
[[Reexport]]
124+
deps = ["Pkg"]
125+
git-tree-sha1 = "7b1d07f411bc8ddb7977ec7f377b97b158514fe0"
126+
uuid = "189a3867-3050-52da-a836-e630ba90ab69"
127+
version = "0.2.0"
128+
129+
[[Requires]]
130+
deps = ["Test"]
131+
git-tree-sha1 = "f6fbf4ba64d295e146e49e021207993b6b48c7d1"
132+
uuid = "ae029012-a4dd-5104-9daa-d747884805df"
133+
version = "0.5.2"
134+
135+
[[SHA]]
136+
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
137+
138+
[[Serialization]]
139+
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
140+
141+
[[SharedArrays]]
142+
deps = ["Distributed", "Mmap", "Random", "Serialization"]
143+
uuid = "1a1011a3-84de-559e-8e89-a11a2f7dc383"
144+
145+
[[Sockets]]
146+
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
147+
148+
[[SparseArrays]]
149+
deps = ["LinearAlgebra", "Random"]
150+
uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
151+
152+
[[Statistics]]
153+
deps = ["LinearAlgebra", "SparseArrays"]
154+
uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
155+
156+
[[Test]]
157+
deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
158+
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
159+
160+
[[URIParser]]
161+
deps = ["Test", "Unicode"]
162+
git-tree-sha1 = "6ddf8244220dfda2f17539fa8c9de20d6c575b69"
163+
uuid = "30578b45-9adc-5946-b283-645ec420af67"
164+
version = "0.4.0"
165+
166+
[[UUIDs]]
167+
deps = ["Random", "SHA"]
168+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
169+
170+
[[Unicode]]
171+
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

‎docs/Project.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[deps]
2+
MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"

‎docs/make.jl

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ using Documenter, MLDatasets
33
makedocs(
44
modules = [MLDatasets],
55
clean = false,
6-
format = :html,
7-
assets = [
8-
joinpath("assets", "favicon.ico"),
9-
],
6+
format = Documenter.HTML(
7+
prettyurls = haskey(ENV, "CI"),
8+
assets = [joinpath("assets", "favicon.ico")]
9+
),
1010
sitename = "MLDatasets.jl",
1111
authors = "Hiroyuki Shindo, Christof Stocker",
1212
linkcheck = !("skiplinks" in ARGS),
@@ -23,14 +23,10 @@ makedocs(
2323
],
2424
hide("Indices" => "indices.md"),
2525
"LICENSE.md",
26-
],
27-
html_prettyurls = !("local" in ARGS),
26+
]
2827
)
2928

30-
deploydocs(
31-
repo = "github.com/JuliaML/MLDatasets.jl.git",
32-
target = "build",
33-
julia = "0.7",
34-
deps = nothing,
35-
make = nothing,
36-
)
29+
30+
deploydocs(repo = "github.com/JuliaML/MLDatasets.jl.git")
31+
32+
deploydocs(repo = "github.com/FluxML/Flux.jl.git")

‎docs/src/datasets/FashionMNIST.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ the Fashion-MNIST dataset in Julia more convenient.
5656

5757
Function | Description
5858
---------|-------------
59-
[`convert2features(array)`](@ref FashionMNIST.convert2features) | Convert the Fashion-MNIST tensor to a flat feature matrix
60-
[`convert2image(array)`](@ref FashionMNIST.convert2image) | Convert the Fashion-MNIST tensor/matrix to a colorant array
59+
[`convert2features(array)`](@ref MNIST.convert2features) | Convert the Fashion-MNIST tensor to a flat feature matrix
60+
[`convert2image(array)`](@ref MNIST.convert2image) | Convert the Fashion-MNIST tensor/matrix to a colorant array
6161

6262
You can use the function
6363
[`convert2features`](@ref FashionMNIST.convert2features) to
@@ -109,14 +109,14 @@ FashionMNIST.testdata
109109

110110
### Utilities
111111

112-
See [`MNIST.convert2features`](@ref) and
113-
[`MNIST.convert2image`](@ref)
114-
115112
```@docs
116113
FashionMNIST.download
117114
FashionMNIST.classnames
118115
```
119116

117+
Also, the `FashionMNIST` module is re-exporting [`convert2features`](@ref MNIST.convert2features)
118+
and [`convert2image`](@ref MNIST.convert2image) from the [`MNIST`](@ref) module.
119+
120120
## References
121121

122122
- **Authors**: Han Xiao, Kashif Rasul, Roland Vollgraf

‎src/FashionMNIST/FashionMNIST.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@ replacement for MNIST.
2020
## Utilities
2121
2222
- [`FashionMNIST.download`](@ref)
23-
- [`MNIST.convert2features`](@ref)
24-
- [`MNIST.convert2image`](@ref)
23+
24+
Also, the `FashionMNIST` module is re-exporting [`convert2features`](@ref MNIST.convert2features)
25+
and [`convert2image`](@ref MNIST.convert2image) from the [`MNIST`](@ref) module.
2526
"""
2627
module FashionMNIST
2728
using DataDeps
2829
using FixedPointNumbers
2930
using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring
31+
import ..MNIST
3032
using ..MNIST: convert2image, convert2features
3133
using ..MNIST.Reader
3234

0 commit comments

Comments
 (0)