Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documenter #122

Merged
merged 9 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 32 additions & 6 deletions .github/workflows/ci.yaml → .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,18 @@ jobs:
fail-fast: false
matrix:
version:
- "1.3"
- "1.6"
- "1"
- "nightly"
os:
- ubuntu-latest
- windows-latest
- macos-latest
arch:
- x64
- x86
exclude:
- os: macos-latest
arch: x86
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v1
Expand All @@ -41,8 +46,29 @@ jobs:
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-runtest@latest
- uses: julia-actions/julia-processcoverage@v1
continue-on-error: true
- uses: julia-actions/julia-uploadcoveralls@v1
continue-on-error: true
- uses: codecov/codecov-action@v4
with:
file: lcov.info
token: ${{ secrets.CODECOV_TOKEN }}
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v1
with:
version: '1'
- run: |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- run: |
julia --project=docs -e '
using Documenter: doctest
using ArnoldiMethod
doctest(ArnoldiMethod)'
- run: julia --project=docs docs/make.jl
env:
COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
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 = "1"
34 changes: 16 additions & 18 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
using Documenter, ArnoldiMethod

makedocs(
modules = [ArnoldiMethod],
format = :html,
doctest = false,
clean = true,
sitename = "ArnoldiMethod.jl",
pages = [
"Home" => "index.md",
"Theory" => "theory.md",
"Using ArnoldiMethod.jl" => [
"Getting started" => "usage/01_getting_started.md",
"Transformations" => "usage/02_spectral_transformations.md"
]
modules = [ArnoldiMethod],
sitename = "ArnoldiMethod.jl",
format = Documenter.HTML(),
pages = [
"Home" => "index.md",
"Theory" => "theory.md",
"Using ArnoldiMethod.jl" => [
"Getting started" => "usage/01_getting_started.md",
"Transformations" => "usage/02_spectral_transformations.md"
]
],
warnonly = [:missing_docs, :cross_references],
)

# Documenter can also automatically deploy documentation to gh-pages.
# See "Hosting Documentation" and deploydocs() in the Documenter manual
# for more information.
deploydocs(
repo = "github.com/JuliaLinearAlgebra/ArnoldiMethod.jl.git",
target = "build",
osname = "linux",
julia = "0.7",
deps = nothing,
make = nothing,
repo = "github.com/JuliaLinearAlgebra/ArnoldiMethod.jl.git",
devbranch="master"
)
Loading