Merge pull request #99 from ArnoStrouwen/docs1

Documenter 1.0 upgrade

Author: ChrisRackauckas

.github/workflows/CI.yml

@@ -3,9 +3,13 @@ on:
   pull_request:
     branches:
       - main
+    paths-ignore:
+      - 'docs/**'
   push:
     branches:
       - main
+    paths-ignore:
+      - 'docs/**'
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.

docs/Project.toml

@@ -1,7 +1,8 @@
 [deps]
+DeepEquilibriumNetworks = "6748aba7-0e9b-415e-a410-ae3cc0ecb334"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 
 [compat]
-Documenter = "0.27, 1"
+Documenter = "1"
 DocumenterCitations = "0.2, 1"

docs/make.jl

@@ -7,25 +7,14 @@ bib = CitationBibliography(joinpath(@__DIR__, "ref.bib"); style=:authoryear)
 
 include("pages.jl")
 
-makedocs(bib;
+makedocs(;
     sitename="Fast Deep Equilibrium Networks",
     authors="Avik Pal et al.",
-    clean=true,
-    doctest=false,
     modules=[DeepEquilibriumNetworks],
-    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
-    ],
-    checkdocs=:all,
-    format=Documenter.HTML(;
-        assets=["assets/favicon.ico"],
+    clean=true, doctest=false, linkcheck = true,
+    format=Documenter.HTML(;assets=["assets/favicon.ico"],
         canonical="https://docs.sciml.ai/DeepEquilibriumNetworks/stable/"),
+    plugins = [bib],
     pages)
 
 deploydocs(; repo="github.com/SciML/DeepEquilibriumNetworks.jl.git", push_preview=true)

docs/ref.bib

@@ -1,10 +1,10 @@
 @article{pal2022mixing,
-      title={Mixing Implicit and Explicit Deep Learning with Skip DEQs and Infinite Time Neural ODEs (Continuous DEQs)}, 
-      author={Avik Pal and Alan Edelman and Christopher Rackauckas},
-      year={2022},
-      eprint={2201.12240},
-      archivePrefix={arXiv},
-      primaryClass={cs.LG}
+	title={Mixing implicit and explicit deep learning with skip DEQs and infinite time neural odes (continuous DEQs)},
+	author={Pal, Avik and Edelman, Alan and Rackauckas, Christopher},
+	journal={Training},
+	volume={4},
+	pages={5},
+	year={2022}
 }
 
 @article{baideep2019,

docs/src/index.md

@@ -120,38 +120,19 @@ Pkg.status(; mode=PKGMODE_MANIFEST) # hide
 </details>
 ```
 
-```@raw html
-You can also download 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/Manifest.toml"
-```
-
-```@raw html
-">manifest</a> file and 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/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.
+""")
 ```