Add contents page to docs

simonp0420 · Jan 15, 2025 · f51cd9e · f51cd9e
1 parent b42653c
commit f51cd9e
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 11 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -29,6 +29,7 @@ makedocs(;
         size_threshold = nothing,
     ),
     pages=[
+        "Contents" => "contents.md",
         "Home" => "index.md",
         "User Manual" => "manual.md",
         demopage,

diff --git a/docs/notebooks/manual.ipynb b/docs/notebooks/manual.ipynb
@@ -138,7 +138,7 @@
     "\n",
     "![blackney](./assets/blackney_polarizer_comparison.png)\n",
     "\n",
-    "The PSSFSS run took about 24 seconds on my machine for 4 meanderline PSS sheets\n",
+    "The PSSFSS run took about 14 seconds on my machine for 4 meanderline PSS sheets\n",
     "analyzed at 61 frequencies.\n",
     "\n",
     "I hope this example whetted your appetite to learn\n",
@@ -368,8 +368,8 @@
     "of a Julia `Vector` (i.e., a one-dimensional array). This vector must contain at least two `Layer`\n",
     "objects representing dielectric layers, and zero or more `RWGSheet` instances, representing the zero-thickness\n",
     "PSS or FSS sheets located between the dielectric layers.  These are described below.\n",
-    "### Layer\n",
-    "Dielectric layers are created with the `Layer` function:"
+    "### Dielectric Layers\n",
+    "Dielectric layers are created with the `Layer` constructor function:"
    ],
    "metadata": {
     "name": "A slide ",
@@ -463,7 +463,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "The call to `rectstrip` above creates a `RWGSheet` object for a rectangular strip\n",
+    "The call to `rectstrip` above creates an `RWGSheet` object for a rectangular strip\n",
     "of dimensions 0.5 cm in the x and y directions, lying in a square unit cell of dimension\n",
     "1 cm.  The triangulation uses 10 edges in the x and y directions (`Nx` and `Ny`).\n",
     "\n",

diff --git a/docs/src/contents.md b/docs/src/contents.md
@@ -0,0 +1,8 @@
+
+# Contents
+
+```@contents
+Depth=5
+Pages = ["index.md", "manual.md", "examples.md", "reference.md"]
+```
+
diff --git a/docs/src/manual.md b/docs/src/manual.md
@@ -72,7 +72,7 @@ presented in the paper. Here is the comparison plot:
 
 ![blackney](./assets/blackney_polarizer_comparison.png)
 
-The PSSFSS run took about 24 seconds on my machine for 4 meanderline PSS sheets
+The PSSFSS run took about 14 seconds on my machine for 4 meanderline PSS sheets
 analyzed at 61 frequencies.
 
 I hope this example whetted your appetite to learn
@@ -148,12 +148,12 @@ Here are the steps in the analysis process.
 Each of these steps is examined in detail below...
 
 ## Strata
-The geometry to be analyzed is passed as the first argument of the `analyze` function in the form
+The geometry to be analyzed is passed as the first argument of the [`analyze`](@ref) function in the form
 of a Julia `Vector` (i.e., a one-dimensional array). This vector must contain at least two `Layer`
 objects representing dielectric layers, and zero or more `RWGSheet` instances, representing the zero-thickness
 PSS or FSS sheets located between the dielectric layers.  These are described below.
-### Layer
-Dielectric layers are created with the [`Layer`](@ref) function:
+### Dielectric Layers
+Dielectric layers are created with the [`Layer`](@ref) constructor function:
 
 ```@repl manual
 using PSSFSS # Brings PSSFSS functions and types into scope
@@ -182,7 +182,7 @@ created by calling a constructor function for a particular style of sheet:
 patch = rectstrip(Nx=10, Ny=10, Px=1, Py=1, Lx=0.5, Ly=0.5, units=cm)
 ```
 
-The call to [`rectstrip`](@ref) above creates a `RWGSheet` object for a rectangular strip
+The call to [`rectstrip`](@ref) above creates an `RWGSheet` object for a rectangular strip
 of dimensions 0.5 cm in the x and y directions, lying in a square unit cell of dimension
 1 cm.  The triangulation uses 10 edges in the x and y directions (`Nx` and `Ny`).
 

diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -22,6 +22,7 @@ read_sheet_data
 rectstrip
 res2fresnel
 res2tep
+RWGSheet
 sinuous
 splitring
 ```

diff --git a/src/Sheets.jl b/src/Sheets.jl
@@ -21,8 +21,8 @@ abstract type Sheet end
     RWGSheet 
 A type that represents a zero-thickness sheet of periodically patterned metalization.  Particular instances 
 are created by calling a constructor function for a specific type of sheet geometry.  These include:
-[`diagstrip`](@ref), [`jerusalemcross`](@ref), [`loadedcross`](@ref), [`manji`](@ref), [`meander`](@ref), 
-[`pecsheet`](@ref), [`pmcsheet`](@ref), [`polyring`](@ref), [`rectstrip`](@ref), [`sinuous`](@ref), and [`splitring`](@ref).
+`diagstrip`, `jerusalemcross`, `loadedcross`, `manji`, `meander`, `pecsheet`, `pmcsheet`, `polyring`,
+`rectstrip`, `sinuous`, and `splitring`.
 """
 mutable struct RWGSheet <: Sheet
     style::String