Merge pull request #18 from alan-turing-institute/dev

Add autoscitype

Author: ablaom

.travis.yml

@@ -2,7 +2,6 @@
 language: julia
 os:
   - linux
-  - osx
 julia:
   - 1.0
   - 1.1
@@ -21,19 +20,13 @@ matrix:
 after_success:
   - julia -e 'using Pkg; pkg"add Coverage"; using Coverage; Codecov.submit(Codecov.process_folder())'
 
-## uncomment following lines to deploy documentation
-## jobs:
-##   include:
-##     - stage: "Documentation"
-##       julia: 1.1
-##       os: linux
-##       # disable global before_script in order not to install Compose twice
-##       before_script:
-##       script:
-##         - |
-##           julia --color=yes --project=docs/ -e'
-##             using Pkg
-##             Pkg.add(PackageSpec(name="MLJBase", rev="master"));Pkg.add(PackageSpec(name="MLJModels", rev="master"));Pkg.develop(PackageSpec(path=pwd()))
-##             Pkg.instantiate()
-##             include("docs/make.jl")
-##          '
+jobs:
+  include:
+    - stage: "Documentation"
+      julia: 1.2
+      os: linux
+      script:
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
+                                               Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip

LICENCE.md

@@ -1,7 +1,7 @@
 The MLJ.jl package is licensed under the MIT "Expat" License:
 
-> Copyright (c) 2018: Edoardo Barp, Anthony Blaom, Gergö Bohner, Valentin Churavy, Harvey Devereux, Thibaut Lienart,
-Franz J Király, Mohammed Nook, Annika Stechemesser, Sebastian Vollmer; Mike Innes in partnership with Julia Computing.
+> Copyright (c) 2019: Anthony Blaom, Thibaut Lienart, Franz J Király
+> and contributors.
 > 
 > Permission is hereby granted, free of charge, to any person obtaining a copy
 > of this software and associated documentation files (the "Software"), to deal

Project.toml

@@ -1,7 +1,7 @@
 name = "ScientificTypes"
 uuid = "321657f4-b219-11e9-178b-2701a2544e81"
 authors = ["Anthony D. Blaom <[email protected]>"]
-version = "0.2.0"
+version = "0.2.1"
 
 [deps]
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
@@ -14,8 +14,9 @@ julia = "1"
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"
 ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["AbstractTrees", "CategoricalArrays", "ColorTypes", "Tables", "Test"]
+test = ["AbstractTrees", "CategoricalArrays", "ColorTypes", "Random", "Tables", "Test"]

README.md

@@ -1,4 +1,3 @@
-
 ## ScientificTypes
 
 A light-weight julia interface for implementing conventions about the

docs/Project.toml

@@ -1,10 +1,10 @@
 [deps]
-AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
-CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"
-ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
-DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
-Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 ScientificTypes = "321657f4-b219-11e9-178b-2701a2544e81"
+CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
+
+[compat]
+Documenter = "^0.23"

docs/make.jl

@@ -1,27 +1,22 @@
-srcdir = joinpath(@__DIR__(), "src")
-
-# ENV["TRAVIS_REPO_SLUG"]="" #"alan-turing-institute/MLJ.jl"
-
-using Literate
-Literate.notebook(joinpath(srcdir, "index.jl"), srcdir)
-
-# currently getting markdown by exported from notebook, as I can't get
-# documeter to work.
-
-# Literate.markdown(joinpath(srcdir, "index.jl"), srcdir,
-#                   codefence = "```@repl scitypes" => "```")
-
-# using Documenter
-# using ScientificTypes
-
-# makedocs(
-#     sitename = "ScientificTypes",
-#     format = Documenter.HTML(),
-#     modules = [ScientificTypes],
-#     pages = Any["ScientificTypes"=>"index.md"]
-# )
-
-# deploydocs(
-#     repo = "github.com/alan-turing-institute/ScientificTypes.jl.git"
-# )
-
+using Documenter, ScientificTypes
+
+makedocs(
+    modules = [ScientificTypes],
+    format = Documenter.HTML(
+        prettyurls = !("local" in ARGS),
+        assets = ["assets/custom.css"]
+        ),
+    sitename = "ScientificTypes.jl",
+    authors = "Anthony Blaom, Thibaut Lienart, and contributors.",
+    pages = [
+        "Home" => "index.md",
+        # "Manual" => [
+        # ],
+        # "Library" => [
+        # ],
+    ]
+)
+
+deploydocs(
+    repo = "github.com/alan-turing-institute/ScientificTypes.jl"
+)

docs/src/assets/custom.css

@@ -0,0 +1,54 @@
+body {
+    font-family: Helvetica;
+    text-rendering: optimizeLegibility;
+    line-height: 1.5;
+    color: #363636;
+}
+
+article {
+    margin-left: 16em;
+}
+
+@media only screen and (max-width:768px) {
+    article {
+        margin-left: 0;
+        padding: 3em, 0.9em, 0, 0.9em;
+        overflow-wrap: break-word;
+    }
+}
+
+nav.toc {
+    width: 15em;
+}
+
+nav.toc ul li ul li.current ul.internal li a.toctext:before {
+    content:"• ";
+}
+
+blockquote {
+    background-color: #e6f9f2;
+    font-style: italic;
+    border-left: 5px solid cadetblue;
+    padding-left: 5px;
+}
+blockquote p {
+    padding-top: 7px;
+    padding-bottom: 5px;
+}
+
+.admonition.important > .admonition-title {
+    visibility: hidden;
+    height: 0;
+}
+
+.admonition.important {
+    background-color: lemonchiffon;
+}
+
+code {color: #cc0066;}
+
+a code {color: inherit;}
+
+pre code {color: black;}
+
+table code {color: black;}