From ed30f675cf1642fb6a36797ff0597e3a1b956155 Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Mon, 25 Sep 2023 06:07:57 +0200 Subject: [PATCH] Documenter 1.0 upgrade --- .github/workflows/CI.yml | 4 ++++ docs/Project.toml | 2 +- docs/make.jl | 11 +-------- docs/src/index.md | 48 ++++++++++++++++------------------------ 4 files changed, 25 insertions(+), 40 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 72d19e2..f77e29f 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -3,9 +3,13 @@ on: pull_request: branches: - master + paths-ignore: + - 'docs/**' push: branches: - master + paths-ignore: + - 'docs/**' jobs: test: runs-on: ubuntu-latest diff --git a/docs/Project.toml b/docs/Project.toml index f29f740..40205c4 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,5 +3,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" LabelledArrays = "2ee39098-c373-598a-b85f-a56591580800" [compat] -Documenter = "0.27" +Documenter = "1" LabelledArrays = "1.12" \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl index 2ef2a9f..d404b7b 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -9,16 +9,7 @@ makedocs(sitename = "LabelledArrays.jl", authors = "Chris Rackauckas", modules = [LabelledArrays], clean = true, doctest = false, linkcheck = true, - strict = [ - :doctest, - :linkcheck, - :parse_error, - :example_block, - # Other available options are - # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block - ], - format = Documenter.HTML(analytics = "UA-90474609-3", - assets = ["assets/favicon.ico"], + format = Documenter.HTML(assets = ["assets/favicon.ico"], canonical = "https://docs.sciml.ai/LabelledArrays/stable/"), pages = pages) diff --git a/docs/src/index.md b/docs/src/index.md index 3c2775d..93b0b42 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -20,12 +20,15 @@ Pkg.add("LabelledArrays") [SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md) for guidance on PRs, issues, and other matters relating to contributing to SciML. + - See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions. - There are a few community forums: - + the #diffeq-bridged channel in the [Julia Slack](https://julialang.org/slack/) - + [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter - + on the [Julia Discourse forums](https://discourse.julialang.org) - + see also [SciML Community page](https://sciml.ai/community/) + + The #diffeq-bridged and #sciml-bridged channels in the + [Julia Slack](https://julialang.org/slack/) + + The #diffeq-bridged and #sciml-bridged channels in the + [Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged) + + On the [Julia Discourse forums](https://discourse.julialang.org) + + See also [SciML Community page](https://sciml.ai/community/) ## Reproducibility @@ -68,32 +71,19 @@ Pkg.status(; mode = PKGMODE_MANIFEST) # hide ``` -```@raw html -You can also download the -manifest file and the -project file. -``` +link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * + "/assets/Manifest.toml" +link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * + "/assets/Project.toml" +Markdown.parse("""You can also download the +[manifest]($link_manifest) +file and the +[project]($link_project) +file. +""") +``` \ No newline at end of file