Skip to content

Commit

Permalink
Moving to use Pkg3 and new Documenter (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
mauro3 authored Jul 18, 2019
1 parent 05fd003 commit 808c90c
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 15 deletions.
17 changes: 11 additions & 6 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ os:
- linux
- osx
julia:
- 0.7
- 1.0
- nightly
matrix:
Expand All @@ -17,8 +16,14 @@ notifications:
# https://github.com/travis-ci/travis-ci/issues/4942
git:
depth: 99999
## Documeter.jl
after_success:
- julia -e 'using Pkg; ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
- julia -e 'import Parameters; cd(joinpath(dirname(pathof(Parameters)), "..")); include(joinpath("docs", "make.jl"))'
- julia -e 'using Pkg; cd(Pkg.dir("Parameters")); Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder())'
## Documeter.jl https://discourse.julialang.org/t/psa-use-a-project-for-building-your-docs/14974/5
jobs:
include:
- stage: "Documentation"
julia: 1.0
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
19 changes: 19 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name = "Parameters"
uuid = "d96e819e-fc66-5662-9728-84c9c7592b0a"
author = ["Mauro Werder <[email protected]>"]
version = "0.11.0"

[deps]
OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"

[compat]
OrderedCollections = "≥ 0.1.0"
julia = "≥ 1.0.0"

[extras]
Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["REPL", "Test", "Markdown"]
2 changes: 0 additions & 2 deletions REQUIRE

This file was deleted.

1 change: 0 additions & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
environment:
matrix:
- julia_version: 0.7
- julia_version: 1.0
- julia_version: latest

Expand Down
5 changes: 5 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "~0.22"
10 changes: 4 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
using Documenter, Parameters
makedocs(
format = :html,
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true"
),
sitename = "Parameters.jl",
# pages also make the side-bar
pages = Any[
Expand All @@ -10,9 +12,5 @@ makedocs(
)

deploydocs(
repo = "github.com/mauro3/Parameters.jl.git",
julia = "1.0",
target = "build",
deps = nothing,
make = nothing
repo = "github.com/mauro3/Parameters.jl.git"
)

2 comments on commit 808c90c

@mauro3
Copy link
Owner Author

@mauro3 mauro3 commented on 808c90c Jul 18, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

Moved from REQUIRE to Project.toml.
Dropped Julia 0.7 support
Updated Documenter to new setup.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/2099

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if Julia TagBot is installed, or can be done manually through the github interface, or via:

git tag -a v0.11.0 -m "<description of version>" 808c90cf3b6c6a1cd956f59c2ee3ba0be7b8b96a
git push origin v0.11.0

Please sign in to comment.