From 4fb8f21b3f431d0c7669172d874886e8d171edf9 Mon Sep 17 00:00:00 2001 From: Altay Sansal Date: Wed, 28 Feb 2024 19:28:01 -0600 Subject: [PATCH] Remove 'data_models/index.md' and update documentation structure 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. --- docs/data_models/header.md | 2 +- docs/data_models/index.md | 10 ---------- docs/data_models/trace.md | 2 +- docs/index.md | 7 ++----- docs/tutorials/quickstart.ipynb | 7 +++++++ 5 files changed, 11 insertions(+), 17 deletions(-) delete mode 100644 docs/data_models/index.md diff --git a/docs/data_models/header.md b/docs/data_models/header.md index f5bfe6a..52a4584 100644 --- a/docs/data_models/header.md +++ b/docs/data_models/header.md @@ -6,7 +6,7 @@ ``` -# SEG-Y File Headers +# File Headers ```{article-info} :author: Altay Sansal diff --git a/docs/data_models/index.md b/docs/data_models/index.md deleted file mode 100644 index 0f1aaec..0000000 --- a/docs/data_models/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Dataset Models - -This section contains the data models for the MDIO format. - -```{toctree} -:maxdepth: 2 - -header -trace -``` diff --git a/docs/data_models/trace.md b/docs/data_models/trace.md index 91660d9..f8e9523 100644 --- a/docs/data_models/trace.md +++ b/docs/data_models/trace.md @@ -6,7 +6,7 @@ ``` -# SEG-Y Traces +# Traces ```{article-info} :author: Altay Sansal diff --git a/docs/index.md b/docs/index.md index 62b6cf2..78f6811 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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} diff --git a/docs/tutorials/quickstart.ipynb b/docs/tutorials/quickstart.ipynb index 58f2a29..53750ad 100644 --- a/docs/tutorials/quickstart.ipynb +++ b/docs/tutorials/quickstart.ipynb @@ -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",