Skip to content

Commit

Permalink
Remove 'data_models/index.md' and update documentation structure
Browse files Browse the repository at this point in the history
The 'data_models/index.md' file is deleted, highlighting a significant restructuring of the documentation. The titles for 'header.md' and 'trace.md' in data_models were simplified, and their references updated in 'index.md'. Additional metadata was also added to the 'quickstart.ipynb' tutorial.
  • Loading branch information
Altay Sansal committed Feb 29, 2024
1 parent eda79f0 commit 4fb8f21
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/data_models/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
```

# SEG-Y File Headers
# File Headers

```{article-info}
:author: Altay Sansal
Expand Down
10 changes: 0 additions & 10 deletions docs/data_models/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/data_models/trace.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
```

# SEG-Y Traces
# Traces

```{article-info}
:author: Altay Sansal
Expand Down
7 changes: 2 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,8 @@ api_reference
:hidden:
:caption: Core Concepts and Structures
data_models/index
data_models/dimensions
data_models/chunk_grids
data_models/data_types
data_models/compressors
data_models/header
data_models/trace
```

```{toctree}
Expand Down
7 changes: 7 additions & 0 deletions docs/tutorials/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
"source": [
"# Read Data from the Cloud\n",
"\n",
"```{article-info}\n",
":author: Altay Sansal\n",
":date: \"{sub-ref}`today`\"\n",
":read-time: \"{sub-ref}`wordcount-minutes` min read\"\n",
":class-container: sd-p-0 sd-outline-muted sd-rounded-3 sd-font-weight-light\n",
"```\n",
"\n",
"Specify path and \"open\" the cloud file. In here opening means it builds a SEG-Y standard\n",
"spec by using some information from the binary file header to be able to read anything else\n",
"from the file. \n",
Expand Down

0 comments on commit 4fb8f21

Please sign in to comment.