From 1d9b54a08d731b50410ca9e74037188bee137b96 Mon Sep 17 00:00:00 2001 From: AtilaSaraiva Date: Fri, 26 Jul 2024 11:22:31 -0600 Subject: [PATCH 1/2] removing Manifest.toml from doc environment --- docs/Manifest.toml | 152 --------------------------------------------- 1 file changed, 152 deletions(-) delete mode 100644 docs/Manifest.toml diff --git a/docs/Manifest.toml b/docs/Manifest.toml deleted file mode 100644 index 6d25892..0000000 --- a/docs/Manifest.toml +++ /dev/null @@ -1,152 +0,0 @@ -# This file is machine-generated - editing it directly is not advised - -[[Base64]] -uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" - -[[BinaryProvider]] -deps = ["Libdl", "SHA"] -git-tree-sha1 = "5b08ed6036d9d3f0ee6369410b830f8873d4024c" -uuid = "b99e7846-7c00-51b0-8f62-c81ae34c0232" -version = "0.5.8" - -[[Dates]] -deps = ["Printf"] -uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" - -[[Distributed]] -deps = ["Random", "Serialization", "Sockets"] -uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b" - -[[DocStringExtensions]] -deps = ["LibGit2", "Markdown", "Pkg", "Test"] -git-tree-sha1 = "88bb0edb352b16608036faadcc071adda068582a" -uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" -version = "0.8.1" - -[[DocumentationGenerator]] -deps = ["Documenter", "GitHub", "JSON", "Markdown", "Pkg"] -git-tree-sha1 = "7ca76ec67a6674e8e3783902c50c92db4c12cd00" -uuid = "8f0d3306-d70b-5309-b898-24bb6ab47850" -version = "0.1.2" - -[[Documenter]] -deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] -git-tree-sha1 = "d45c163c7a3ae293c15361acc52882c0f853f97c" -uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -version = "0.23.4" - -[[DocumenterTools]] -deps = ["Base64", "DocStringExtensions", "LibGit2"] -git-tree-sha1 = "58db9d1c626de92318ee35cbaf466739f4b5a09a" -uuid = "35a29f4d-8980-5a13-9543-d66fff28ecb8" -version = "0.1.2" - -[[GitHub]] -deps = ["Base64", "Dates", "HTTP", "JSON", "MbedTLS", "Sockets"] -git-tree-sha1 = "477818ab174a14d4730b3d15ac8719dbc98555d2" -uuid = "bc5e4493-9b4d-5f90-b8aa-2b2bcaad7a26" -version = "5.1.3" - -[[HTTP]] -deps = ["Base64", "Dates", "IniFile", "MbedTLS", "Sockets"] -git-tree-sha1 = "5c49dab19938b119fe204fd7d7e8e174f4e9c68b" -uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3" -version = "0.8.8" - -[[IniFile]] -deps = ["Test"] -git-tree-sha1 = "098e4d2c533924c921f9f9847274f2ad89e018b8" -uuid = "83e8ac13-25f8-5344-8a64-a9f2b223428f" -version = "0.5.0" - -[[InteractiveUtils]] -deps = ["Markdown"] -uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" - -[[JSON]] -deps = ["Dates", "Mmap", "Parsers", "Unicode"] -git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e" -uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" -version = "0.21.0" - -[[LibGit2]] -uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" - -[[Libdl]] -uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" - -[[LinearAlgebra]] -deps = ["Libdl"] -uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" - -[[Logging]] -uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" - -[[Markdown]] -deps = ["Base64"] -uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" - -[[MbedTLS]] -deps = ["BinaryProvider", "Dates", "Distributed", "Libdl", "Random", "Sockets", "Test"] -git-tree-sha1 = "2d94286a9c2f52c63a16146bb86fd6cdfbf677c6" -uuid = "739be429-bea8-5141-9913-cc70e7f3736d" -version = "0.6.8" - -[[Mmap]] -uuid = "a63ad114-7e13-5084-954f-fe012c677804" - -[[Parsers]] -deps = ["Dates", "Test"] -git-tree-sha1 = "c56ecb484f286639f161e712b8311f5ab77e8d32" -uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" -version = "0.3.8" - -[[Pkg]] -deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] -uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" - -[[Printf]] -deps = ["Unicode"] -uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7" - -[[REPL]] -deps = ["InteractiveUtils", "Markdown", "Sockets"] -uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb" - -[[Random]] -deps = ["Serialization"] -uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" - -[[SHA]] -uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" - -[[SeisMain]] -deps = ["Distributed", "DocumentationGenerator", "Documenter", "DocumenterTools", "Printf", "Statistics", "Test"] -path = "/Users/fercarozzi/Documents/Fer/PhD/2019/seismic/juliaproject/SeisMain.jl" -uuid = "5696fd22-15e8-11e9-1986-f9ab08703604" -version = "0.1.0" - -[[Serialization]] -uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" - -[[Sockets]] -uuid = "6462fe0b-24de-5631-8697-dd941f90decc" - -[[SparseArrays]] -deps = ["LinearAlgebra", "Random"] -uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" - -[[Statistics]] -deps = ["LinearAlgebra", "SparseArrays"] -uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" - -[[Test]] -deps = ["Distributed", "InteractiveUtils", "Logging", "Random"] -uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" - -[[UUIDs]] -deps = ["Random", "SHA"] -uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4" - -[[Unicode]] -uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" From 61adbc62fb99eb57237635c708c6429ec5b9e784 Mon Sep 17 00:00:00 2001 From: AtilaSaraiva Date: Fri, 26 Jul 2024 11:27:26 -0600 Subject: [PATCH 2/2] making some improvements to the docs and fixing deployment --- docs/make.jl | 8 +++----- docs/src/index.md | 12 ++++++++---- docs/src/lib/public.md | 3 +++ 3 files changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index e0cee32..8b893df 100644 --- 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 index 0b13d61..88c70d0 100644 --- 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 index fd12a81..6a266b0 100644 --- 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 ```