Mercurial > repos > public > sbplib_julia

changeset 837:126e169bb0b7 feature/setup_documenter

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial setup of Documenter.jl
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 09:01:12 +0100
parents 3c1dd7692797
children 76e5682d0e52
files .hgignore docs/Manifest.toml docs/Project.toml docs/make.jl docs/src/doc_index.md docs/src/index.md docs/src/submodules/diff_ops.md docs/src/submodules/grids.md docs/src/submodules/lazy_tensors.md docs/src/submodules/region_indices.md docs/src/submodules/sbp_operators.md docs/src/submodules/static_dicts.md
diffstat 12 files changed, 331 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.hgignore	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,2 @@
+syntax: glob
+docs/build/
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/Manifest.toml	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,145 @@
+# This file is machine-generated - editing it directly is not advised
+
+julia_version = "1.7.1"
+manifest_format = "2.0"
+
+[[deps.ANSIColoredPrinters]]
+git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
+uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
+version = "0.0.1"
+
+[[deps.Adapt]]
+deps = ["LinearAlgebra"]
+git-tree-sha1 = "af92965fb30777147966f58acb05da51c5616b5f"
+uuid = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
+version = "3.3.3"
+
+[[deps.Artifacts]]
+uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
+
+[[deps.Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+
+[[deps.CompilerSupportLibraries_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "e66e0078-7015-5450-92f7-15fbd957f2ae"
+
+[[deps.Dates]]
+deps = ["Printf"]
+uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
+
+[[deps.DocStringExtensions]]
+deps = ["LibGit2"]
+git-tree-sha1 = "b19534d1895d702889b219c382a6e18010797f0b"
+uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+version = "0.8.6"
+
+[[deps.Documenter]]
+deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
+git-tree-sha1 = "f425293f7e0acaf9144de6d731772de156676233"
+uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+version = "0.27.10"
+
+[[deps.IOCapture]]
+deps = ["Logging", "Random"]
+git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
+uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
+version = "0.2.2"
+
+[[deps.InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+
+[[deps.JSON]]
+deps = ["Dates", "Mmap", "Parsers", "Unicode"]
+git-tree-sha1 = "8076680b162ada2a031f707ac7b4953e30667a37"
+uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+version = "0.21.2"
+
+[[deps.LibGit2]]
+deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
+uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
+
+[[deps.Libdl]]
+uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+
+[[deps.LinearAlgebra]]
+deps = ["Libdl", "libblastrampoline_jll"]
+uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+
+[[deps.Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+
+[[deps.Markdown]]
+deps = ["Base64"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+
+[[deps.Mmap]]
+uuid = "a63ad114-7e13-5084-954f-fe012c677804"
+
+[[deps.NetworkOptions]]
+uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
+
+[[deps.OffsetArrays]]
+deps = ["Adapt"]
+git-tree-sha1 = "043017e0bdeff61cfbb7afeb558ab29536bbb5ed"
+uuid = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
+version = "1.10.8"
+
+[[deps.OpenBLAS_jll]]
+deps = ["Artifacts", "CompilerSupportLibraries_jll", "Libdl"]
+uuid = "4536629a-c528-5b80-bd46-f80d51c5b363"
+
+[[deps.Parsers]]
+deps = ["Dates"]
+git-tree-sha1 = "d7fa6237da8004be601e19bd6666083056649918"
+uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
+version = "2.1.3"
+
+[[deps.Printf]]
+deps = ["Unicode"]
+uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[[deps.REPL]]
+deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
+uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
+
+[[deps.Random]]
+deps = ["SHA", "Serialization"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[[deps.SHA]]
+uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+
+[[deps.Sbplib]]
+deps = ["TOML", "TiledIteration"]
+path = ".."
+uuid = "5a373a26-915f-4769-bcab-bf03835de17b"
+version = "0.1.0"
+
+[[deps.Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+
+[[deps.Sockets]]
+uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[[deps.TOML]]
+deps = ["Dates"]
+uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
+
+[[deps.Test]]
+deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
+uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[[deps.TiledIteration]]
+deps = ["OffsetArrays"]
+git-tree-sha1 = "5683455224ba92ef59db72d10690690f4a8dc297"
+uuid = "06e1c1a7-607b-532d-9fad-de7d9aa2abac"
+version = "0.3.1"
+
+[[deps.Unicode]]
+uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
+
+[[deps.libblastrampoline_jll]]
+deps = ["Artifacts", "Libdl", "OpenBLAS_jll"]
+uuid = "8e850b90-86db-534c-a0d3-1478176c7d93"
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/Project.toml	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Sbplib = "5a373a26-915f-4769-bcab-bf03835de17b"
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/make.jl	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,30 @@
+using Documenter
+using Sbplib
+
+using Sbplib.DiffOps
+using Sbplib.Grids
+using Sbplib.LazyTensors
+using Sbplib.RegionIndices
+using Sbplib.SbpOperators
+using Sbplib.StaticDicts
+
+
+sitename = "Sbplib.jl"
+prettyurls = false
+pages = [
+    "index.md",
+    "Submodules" => [
+        "submodules/grids.md",
+        "submodules/diff_ops.md",
+        "submodules/lazy_tensors.md",
+        "submodules/region_indices.md",
+        "submodules/sbp_operators.md",
+        "submodules/static_dicts.md",
+    ],
+    "doc_index.md",
+]
+# This ordering is not respected by @contents. See https://github.com/JuliaDocs/Documenter.jl/issues/936
+
+format=Documenter.HTML(;prettyurls)
+makedocs(;sitename, pages, format)
+# TBD: Should `prettyurls` be true or false when this is deployed to a webserver?
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/doc_index.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,4 @@
+# Interface index
+
+```@index
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/index.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,9 @@
+# Sbplib.jl
+
+```@contents
+Depth = 1
+```
+
+> Matrix free finite differences methods for all!
+>
+>  -- The mighty Trocatron, ruler of errors and grids
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/submodules/diff_ops.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,23 @@
+# DiffOps
+
+## Contents
+```@contents
+Pages = ["diff_ops.md"]
+```
+
+## Index
+```@index
+Pages = ["diff_ops.md"]
+```
+
+## Public interface
+```@autodocs
+Modules = [DiffOps]
+Private = false # Hide unexported objects
+```
+
+## Internal interface
+```@autodocs
+Modules = [DiffOps]
+Public = false # Hide exported objects
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/submodules/grids.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,23 @@
+# Grids
+
+## Contents
+```@contents
+Pages = ["grids.md"]
+```
+
+## Index
+```@index
+Pages = ["grids.md"]
+```
+
+## Public interface
+```@autodocs
+Modules = [Grids]
+Private = false # Hide unexported objects
+```
+
+## Internal interface
+```@autodocs
+Modules = [Grids]
+Public = false # Hide exported objects
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/submodules/lazy_tensors.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,23 @@
+# LazyTensors
+
+## Contents
+```@contents
+Pages = ["lazy_tensors.md"]
+```
+
+## Index
+```@index
+Pages = ["lazy_tensors.md"]
+```
+
+## Public interface
+```@autodocs
+Modules = [LazyTensors]
+Private = false # Hide unexported objects
+```
+
+## Internal interface
+```@autodocs
+Modules = [LazyTensors]
+Public = false # Hide exported objects
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/submodules/region_indices.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,23 @@
+# RegionIndices
+
+## Contents
+```@contents
+Pages = ["region_indices.md"]
+```
+
+## Index
+```@index
+Pages = ["region_indices.md"]
+```
+
+## Public interface
+```@autodocs
+Modules = [RegionIndices]
+Private = false # Hide unexported objects
+```
+
+## Internal interface
+```@autodocs
+Modules = [RegionIndices]
+Public = false # Hide exported objects
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/submodules/sbp_operators.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,23 @@
+# SbpOperators
+
+## Contents
+```@contents
+Pages = ["sbp_operators.md"]
+```
+
+## Index
+```@index
+Pages = ["sbp_operators.md"]
+```
+
+## Public interface
+```@autodocs
+Modules = [SbpOperators]
+Private = false # Hide unexported objects
+```
+
+## Internal interface
+```@autodocs
+Modules = [SbpOperators]
+Public = false # Hide exported objects
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/src/submodules/static_dicts.md	Fri Jan 14 09:01:12 2022 +0100
@@ -0,0 +1,23 @@
+# StaticDicts
+
+## Contents
+```@contents
+Pages = ["static_dicts.md"]
+```
+
+## Index
+```@index
+Pages = ["static_dicts.md"]
+```
+
+## Public interface
+```@autodocs
+Modules = [StaticDicts]
+Private = false # Hide unexported objects
+```
+
+## Internal interface
+```@autodocs
+Modules = [StaticDicts]
+Public = false # Hide exported objects
+```