-
Notifications
You must be signed in to change notification settings - Fork 34
/
mkdocs.yml
155 lines (147 loc) · 4.59 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
site_name: SEGY-SAK Documentation
site_description: SEGY file loading in Python using Xarray
site_author: Tony Hallam
site_url: https://segysak.readthedocs.io/
repo_name: trhallam/segysak
repo_url: https://github.com/trhallam/segysak
edit_uri: edit/main/docs
copyright: "Tony Hallam"
docs_dir: docs
theme:
name: material
custom_dir: docs/overrides
language: "en"
features:
- navigations.instant
- navigation.tracking
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- content.action.edit
- content.action.view
- content.code.copy
- toc.integrate
- toc.follow
palette:
primary: teal
icon:
repo: fontawesome/brands/github
use_directory_urls: false
# Customization
extra:
version:
provider: mike
extra_css:
- stylesheets/fix-xarray-rep.css
watch:
- docs
- examples
markdown_extensions:
- markdown.extensions.attr_list:
- markdown.extensions.admonition:
- markdown.extensions.footnotes:
- markdown.extensions.md_in_html:
- markdown.extensions.tables:
- codehilite:
guess_lang: false
- markdown.extensions.toc:
permalink: false
- pymdownx.betterem
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.details
- pymdownx.highlight:
use_pygments: true
auto_title: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
base_path:
- docs/.snippets
auto_append:
- links.txt
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.arithmatex:
generic: true
# extra_javascript:
# - javascripts/mathjax.js
# - https://polyfill.io/v3/polyfill.min.js?features=es6
# - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
- simple:
include: [".md", ".cff", "LICENSE", ".ipynb"]
- autorefs
- mkdocs-jupyter:
execute: false
kernel_name: python3
include_source: True
include: ["examples/*.ipynb"]
remove_tag_config:
remove_input_tags:
- hide-code
# execute_ignore:
- mkdocstrings:
default_handler: python
- mike:
alias_type: symlink
redirect_template: null
deploy_prefix: ""
canonical_version: stable
version_selector: true
css_dir: css
javascript_dir: js
nav:
- Home:
- About: index.md
- Walkthrough:
- Installation: installation.md
- Quickstart: quickstart.md
- Upgrading to v0.5: upgrading.md
- Learn:
- Why SEGYSAK: why-segysak.md
- Xarray SEISNC: seisnc.md
- History: history.md
- Community:
- Discussions: https://github.com/trhallam/segysak/discussions
- Issue Tracker: https://github.com/trhallam/segysak/issues
- Contributing: contributing.md
- Examples:
- About: examples_about.md
- Quick Overview: examples/QuickOverview.ipynb
- Segysak Basics: examples/example_segysak_basics.ipynb
- SEG-Y Headers: examples/example_segy_headers.ipynb
- Arbitrary Line: examples/example_extract_arbitrary_line.ipynb
- Amplitude Extraction: examples/example_amplitude_extraction_displays.ipynb
- Data on a Horizon: examples/example_extract_data_on_a_horizon.ipynb
- Depth Conversion: examples/example_depth_conversion.ipynb
- Vectorize SEG-Y for ML: examples/example_segysak_segy_vectorisation.ipynb
- Working with Gathers: examples/example_working_with_3d_gathers.ipynb
- Merge two surveys: examples/example_merge_surveys.ipynb
- Lazy operations with Dask: examples/example_segysak_dask.ipynb
- CLI:
- About: cli/about.md
- Pipelines: cli/command-pipelines.md
- Reference: cli/command-line-ref.md
- Tutorial: tutorial.md
- Meta:
- FAQ: meta/faq.md
- Reference:
- About: api.md
- SEISNC conventions: seisnc-standard.md
- Inspecting SEG-Y: api/segy_inspecting.md
- SEG-Y text header operations: api/segy_text.md
- SEG-Y via Xarray: api/segy_xarray.md
- Xarray Accessor modules: api/xarray_new.md
- Survey Geometry: api/geometry.md
- Package Utils: api/utils.md
- Depreciated Loading SEG-Y: api/segy_loading.md
- Depreciated Writing SEG-Y: api/segy_writing.md
- Depreciated Xarray Accessor modules: api/xarray_accessor.md