From b8220a639fb0bdd3cf9e25c74eb5df1b5895368c Mon Sep 17 00:00:00 2001 From: Dolineanu Mircea Date: Thu, 22 Apr 2021 08:14:00 +0300 Subject: [PATCH] starting setup for documentation --- docs/make.jl | 10 ++++++++++ docs/src/angular_momentum.md | 0 docs/src/fields.md | 0 docs/src/phase_space.md | 0 docs/src/qed.md | 8 ++++++++ docs/src/read.md | 1 + docs/src/statistics.md | 0 docs/src/widgets.md | 1 + 8 files changed, 20 insertions(+) create mode 100644 docs/src/angular_momentum.md create mode 100644 docs/src/fields.md create mode 100644 docs/src/phase_space.md create mode 100644 docs/src/qed.md create mode 100644 docs/src/read.md create mode 100644 docs/src/statistics.md create mode 100644 docs/src/widgets.md diff --git a/docs/make.jl b/docs/make.jl index 9207aa6..3a81d22 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -13,7 +13,17 @@ makedocs(; ), pages=[ "Home" => "index.md", + "read.md", + "Plot recipes" => [ + "Scalar Fields" => "fields.md", + "Angular momentum" => "angular_momentum.md", + "Phase Space" => "phase_space.md", + "QED Particles" => "qed.md", + "Statistics and Control" => "statistics.md" + ], + "widgets.jl" ], + modules = [SDFResultViewer] ) deploydocs(; diff --git a/docs/src/angular_momentum.md b/docs/src/angular_momentum.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/fields.md b/docs/src/fields.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/phase_space.md b/docs/src/phase_space.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/qed.md b/docs/src/qed.md new file mode 100644 index 0000000..6796868 --- /dev/null +++ b/docs/src/qed.md @@ -0,0 +1,8 @@ +### [QED related recipes](@id qed) + +This is a set of plot recipes for analyzing QED effects (primarily photons). + +```@autodocs +Modules = [SDFResultViewer] +Pages = ["src/plots/qed.jl"] +``` \ No newline at end of file diff --git a/docs/src/read.md b/docs/src/read.md new file mode 100644 index 0000000..eaa5890 --- /dev/null +++ b/docs/src/read.md @@ -0,0 +1 @@ +# Quick start examples diff --git a/docs/src/statistics.md b/docs/src/statistics.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/src/widgets.md b/docs/src/widgets.md new file mode 100644 index 0000000..32b1666 --- /dev/null +++ b/docs/src/widgets.md @@ -0,0 +1 @@ +# Widgets \ No newline at end of file