making some improvements to the docs and fixing deployment

SeismicJulia · Jul 26, 2024 · 61adbc6 · 61adbc6
1 parent 1d9b54a
commit 61adbc6
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,6 +1,5 @@
 push!(LOAD_PATH, "../src/")
 
-using Pkg; Pkg.add("Documenter")
 using Documenter, SeisMain
 
 makedocs(
@@ -18,12 +17,11 @@ makedocs(
 			  "Public" => "lib/public.md",
 			  "Internals" => "lib/internals.md"
 				],
-		], 
+		],
 )
 
 deploydocs(
-    repo = "github.com/fercarozzi/SeisMain.jl.git",
+    repo = "github.com/SeismicJulia/SeisMain.jl.git",
     target = "build",
-    deps = nothing,
-    make = nothing
+    devbranch = "master"
 )
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,6 +1,10 @@
+```@meta
+CurrentModule = SeisMain
+```
+
 # SeisMain.jl
 
-* A package to read, write and process seismic data in Julia 
+* A package to read, write and process seismic data in Julia
 
 ## Package Features
 
@@ -12,10 +16,10 @@
 - Once your data is processed, unpatch to a single volume
 
 
-## Installation 
+## Installation
 
 SeisMain, from the SeismicJulia project, can be installed using Julia package manager.
-From the Julia REPL, type `]` to enter the Pkg REPL mode and run 
+From the Julia REPL, type `]` to enter the Pkg REPL mode and run
 ```
-Pkg> add SeisMain
+pkg> add SeisMain
 ```
diff --git a/docs/src/lib/public.md b/docs/src/lib/public.md
@@ -17,7 +17,9 @@ SeisHeaderInfo
 SeisToSegy
 SeisRemove
 SeisWindow
+SeisWindowPatch
 SeisPatch
+SeisPatchProcess
 SeisUnPatch
 SeisGeometry
 SeisBinHeaders
@@ -27,4 +29,5 @@ SeisSort
 ReadSegyHeader
 ExtractSegyHeader
 SegyHeaderInfo
+download_if_needed
 ```