Merge pull request #148 from ArnoStrouwen/docs1

Documenter 1.0 upgrade

Author: ChrisRackauckas

.github/workflows/CI.yml

@@ -4,8 +4,12 @@ env:
 on:
   push:
     branches: '*'
+    paths-ignore:
+      - 'docs/**'
     tags: '*'
   pull_request:
+    paths-ignore:
+      - 'docs/**'
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.

docs/Project.toml

@@ -5,7 +5,7 @@ Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
 NeuralOperators = "ea5c82af-86e5-48da-8ee1-382d6ad7af4b"
 
 [compat]
-Documenter = "0.27"
-DocumenterCitations = "0.2"
+Documenter = "1"
+DocumenterCitations = "1"
 Flux = "0.13"
 NeuralOperators = "0.4"

docs/make.jl

@@ -5,22 +5,23 @@ using DocumenterCitations
 cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
 cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
 
-bib = CitationBibliography(joinpath(@__DIR__, "bibliography.bib"), sorting = :nyt)
+bib = CitationBibliography(joinpath(@__DIR__, "bibliography.bib"), style = :numeric)
 
 DocMeta.setdocmeta!(NeuralOperators, :DocTestSetup, :(using NeuralOperators);
                     recursive = true)
 
 include("pages.jl")
 
-makedocs(bib,
-         modules = [NeuralOperators],
+makedocs(modules = [NeuralOperators],
          authors = "JingYu Ning <foldfelis@gmail.com> and contributors",
          repo = "https://github.com/SciML/NeuralOperators.jl/blob/{commit}{path}#{line}",
          sitename = "NeuralOperators.jl",
+         clean = true, doctest = false, linkcheck = true,
          format = Documenter.HTML(;
                                   prettyurls = get(ENV, "CI", "false") == "true",
                                   canonical = "https://docs.sciml.ai/NeuralOperators/stable/",
                                   assets = ["assets/favicon.ico"]),
+         plugins=[bib],
          pages = pages)
 
 deploydocs(;

docs/src/index.md

@@ -143,32 +143,19 @@ Pkg.status(; mode = PKGMODE_MANIFEST) # hide
 </details>
 ```
 
-```@raw html
-You can also download the 
-<a href="
-```
-
-```@eval
-using TOML
-version = TOML.parse(read("../../Project.toml", String))["version"]
-name = TOML.parse(read("../../Project.toml", String))["name"]
-link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
-       "/assets/Manifest.toml"
-```
-
-```@raw html
-">manifest</a> file and the
-<a href="
-```
-
 ```@eval
 using TOML
+using Markdown
 version = TOML.parse(read("../../Project.toml", String))["version"]
 name = TOML.parse(read("../../Project.toml", String))["name"]
-link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
-       "/assets/Project.toml"
-```
-
-```@raw html
-">project</a> 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.
+""")
+```