diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 00000000..ed025f5a --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,5 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" + +[compat] +Documenter = "~0.25" diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..69966126 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# OptimizationProblems.jl \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 00000000..b021e7ca --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,15 @@ +using Documenter, OptimizationProblems + +makedocs( + modules = [OptimizationProblems], + doctest = true, + # linkcheck = true, + strict = true, + format = Documenter.HTML(assets = ["assets/style.css"], prettyurls = get(ENV, "CI", nothing) == "true"), + sitename = "OptimizationProblems.jl", + pages = Any["Home" => "index.md", + "Tutorial" => "tutorial.md", + "Reference" => "reference.md"] +) + +deploydocs(repo = "github.com/JuliaSmoothOptimizers/OptimizationProblems.jl.git") diff --git a/docs/reference.md b/docs/reference.md new file mode 100644 index 00000000..2dec9b13 --- /dev/null +++ b/docs/reference.md @@ -0,0 +1,4 @@ +# Reference + +```@index +``` diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png new file mode 100644 index 00000000..f1947e99 Binary files /dev/null and b/docs/src/assets/logo.png differ diff --git a/docs/src/assets/style.css b/docs/src/assets/style.css new file mode 100644 index 00000000..7f1fab0d --- /dev/null +++ b/docs/src/assets/style.css @@ -0,0 +1,27 @@ +#documenter .docs-sidebar, +html.theme--documenter-dark #documenter .docs-sidebar { + border-right: 4px solid #640000; + background-color: #8c1515; + color: #fff; +} + +.mi, .mo, .mn { + color: #317293; +} + +a { + color: #3091d1; +} + +a:visited { + color: #3091d1; +} + +a:hover { + color: #ff5722; +} + +nav.toc .logo { + max-width: 256px; + max-height: 256px; +} \ No newline at end of file diff --git a/docs/tutorial.md b/docs/tutorial.md new file mode 100644 index 00000000..ae2691b7 --- /dev/null +++ b/docs/tutorial.md @@ -0,0 +1 @@ +# OptimizationProblems.jl Tutorial \ No newline at end of file