Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing doc deployment #34

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Fixing doc deployment #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d9b54a
removing Manifest.toml from doc environment
AtilaSaraiva Jul 26, 2024
61adbc6
making some improvements to the docs and fixing deployment
AtilaSaraiva Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 0 additions & 152 deletions docs/Manifest.toml
View file
Open in desktop

This file was deleted.

8 changes: 3 additions & 5 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
push!(LOAD_PATH, "../src/")

using Pkg; Pkg.add("Documenter")
using Documenter, SeisMain

makedocs(
Expand All @@ -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"
)
12 changes: 8 additions & 4 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
```
3 changes: 3 additions & 0 deletions docs/src/lib/public.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ SeisHeaderInfo
SeisToSegy
SeisRemove
SeisWindow
SeisWindowPatch
SeisPatch
SeisPatchProcess
SeisUnPatch
SeisGeometry
SeisBinHeaders
Expand All @@ -27,4 +29,5 @@ SeisSort
ReadSegyHeader
ExtractSegyHeader
SegyHeaderInfo
download_if_needed
```
Loading