Add some more Documenter reference tests

This commit is contained in:
Chris de Graaf 2019-11-09 00:28:02 +07:00
parent 8edafa6fe5
commit 90253e580d
No known key found for this signature in database
GPG Key ID: 150FFDD9B0073C7B
21 changed files with 256 additions and 0 deletions

View File

@ -0,0 +1,42 @@
name: CI
on:
- push
- pull_request
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
version:
- '1.0'
- '1.2'
os:
- ubuntu-latest
- macOS-latest
- windows-latest
arch:
- x64
steps:
- uses: actions/checkout@v1
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-runtest@latest
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: julia-actions/setup-julia@latest
with:
version: '1.0'
- run: julia --project=docs -e '
using Pkg;
Pkg.develop(PackageSpec(; path=pwd()));
Pkg.instantiate();'
- run: julia --project=docs docs/make.jl
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@ -0,0 +1,2 @@
/docs/build/
Manifest.toml

View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2019 tester
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -0,0 +1,13 @@
name = "DocumenterGitHubActions"
uuid = "5b7e9947-ddc0-4b3f-9b55-0d8042f74170"
authors = ["tester"]
version = "0.1.0"
[compat]
julia = "1"
[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
[targets]
test = ["Test"]

View File

@ -0,0 +1,5 @@
# DocumenterGitHubActions
[![Build Status](https://github.com/tester/DocumenterGitHubActions.jl/actions)](https://github.com/tester/DocumenterGitHubActions.jl/workflows/CI/badge.svg)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://tester.github.io/DocumenterGitHubActions.jl/stable)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tester.github.io/DocumenterGitHubActions.jl/dev)

View File

@ -0,0 +1,2 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

View File

@ -0,0 +1,21 @@
using DocumenterGitHubActions
using Documenter
makedocs(;
modules=[DocumenterGitHubActions],
authors="tester",
repo="https://github.com/tester/DocumenterGitHubActions.jl/blob/{commit}{path}#L{line}",
sitename="DocumenterGitHubActions.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://tester.github.io/DocumenterGitHubActions.jl",
assets=String[],
),
pages=[
"Home" => "index.md",
],
)
deploydocs(;
repo="github.com/tester/DocumenterGitHubActions.jl",
)

View File

@ -0,0 +1,12 @@
```@meta
CurrentModule = DocumenterGitHubActions
```
# DocumenterGitHubActions
```@index
```
```@autodocs
Modules = [DocumenterGitHubActions]
```

View File

@ -0,0 +1,5 @@
module DocumenterGitHubActions
# Write your package code here.
end

View File

@ -0,0 +1,6 @@
using DocumenterGitHubActions
using Test
@testset "DocumenterGitHubActions.jl" begin
# Write your tests here.
end

View File

@ -0,0 +1,2 @@
/docs/build/
Manifest.toml

View File

@ -0,0 +1,27 @@
# Documentation: http://docs.travis-ci.com/user/languages/julia
language: julia
notifications:
email: false
julia:
- 1.0
- 1.2
- nightly
os:
- linux
- osx
- windows
arch:
- x64
jobs:
fast_finish: true
allow_failures:
- julia: nightly
include:
- stage: Documentation
julia: 1.0
script: julia --project=docs -e '
using Pkg;
Pkg.develop(PackageSpec(; path=pwd()));
Pkg.instantiate();
include("docs/make.jl");'
after_success: skip

21
test/fixtures/DocumenterTravis/LICENSE vendored Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2019 tester
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -0,0 +1,13 @@
name = "DocumenterTravis"
uuid = "5b7e9947-ddc0-4b3f-9b55-0d8042f74170"
authors = ["tester"]
version = "0.1.0"
[compat]
julia = "1"
[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
[targets]
test = ["Test"]

View File

@ -0,0 +1,5 @@
# DocumenterTravis
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://tester.github.io/DocumenterTravis.jl/stable)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tester.github.io/DocumenterTravis.jl/dev)
[![Build Status](https://travis-ci.com/tester/DocumenterTravis.jl.svg?branch=master)](https://travis-ci.com/tester/DocumenterTravis.jl)

View File

@ -0,0 +1,2 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

View File

@ -0,0 +1,21 @@
using DocumenterTravis
using Documenter
makedocs(;
modules=[DocumenterTravis],
authors="tester",
repo="https://github.com/tester/DocumenterTravis.jl/blob/{commit}{path}#L{line}",
sitename="DocumenterTravis.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://tester.github.io/DocumenterTravis.jl",
assets=String[],
),
pages=[
"Home" => "index.md",
],
)
deploydocs(;
repo="github.com/tester/DocumenterTravis.jl",
)

View File

@ -0,0 +1,12 @@
```@meta
CurrentModule = DocumenterTravis
```
# DocumenterTravis
```@index
```
```@autodocs
Modules = [DocumenterTravis]
```

View File

@ -0,0 +1,5 @@
module DocumenterTravis
# Write your package code here.
end

View File

@ -0,0 +1,6 @@
using DocumenterTravis
using Test
@testset "DocumenterTravis.jl" begin
# Write your tests here.
end

View File

@ -27,6 +27,19 @@ end
])
end
@testset "Documenter (TravisCI)" begin
test_all("DocumenterTravis"; authors=USER, plugins=[
Documenter{TravisCI}(), TravisCI(),
])
end
@testset "Documenter (GitHubActions)" begin
test_all("DocumenterGitHubActions"; authors=USER, plugins=[
Documenter{GitHubActions}(), GitHubActions(),
])
end
@testset "Wacky options" begin
test_all("WackyOptions"; authors=USER, julia=v"1.2", plugins=[
AppVeyor(; x86=true, coverage=true, extra_versions=[v"1.3"]),