Skip to content

Commit e47a6e7

Browse files
committed
Remove demo page as notebook page replaces that
1 parent 6b4234f commit e47a6e7

File tree

2 files changed

+28
-15
lines changed

2 files changed

+28
-15
lines changed

docs/usage.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
# Usage
22

3-
Rompy provides a framework for ocean model configuration and setup. Here are some usage examples:
3+
This section has been consolidated into other documentation pages. Please refer to these sections for comprehensive usage information:
44

5-
## Basic Model Run
5+
## Getting Started
66

7-
```python
8-
from rompy import ModelRun
7+
- [**User Guide**](user_guide.md) - Complete tutorial from installation to running your first model
8+
- [**Quickstart**](quickstart.md) - Basic example to quickly get up and running
99

10-
# Create a model run instance
11-
run = ModelRun()
10+
## Tutorials & Examples
1211

13-
# Execute the model run
14-
run()
15-
```
12+
- [**Progressive Tutorials**](progressive_tutorials.md) - Step-by-step tutorials building from basic to advanced usage
13+
- [**Practical Examples**](examples.md) - Real-world scenarios with complete code examples
14+
- [**Common Workflows**](common_workflows.md) - Typical ocean modeling workflows and best practices
15+
16+
## Configuration & Backends
17+
18+
- [**Configuration Deep Dive**](configuration_deep_dive.md) - Detailed configuration options and best practices
19+
- [**Backends**](backends.md) - Execution backends for different environments
20+
- [**Core Concepts**](core_concepts.md) - Key abstractions and design patterns

mkdocs.yml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ nav:
3636
- Backend Reference: developer/backend_reference.md
3737
- API Reference: api.md
3838
- FAQ: faq.md
39-
- Demo: demo.md
4039
- Demonstration Notebooks:
4140
- Rompy core: notebooks/common/rompy_core_features.ipynb
4241
- SWAN:
@@ -46,7 +45,8 @@ nav:
4645
- boundnest1: notebooks/swan/boundary/boundnest1.ipynb
4746
- boundspec_segment: notebooks/swan/boundspec_segment.ipynb
4847
- boundspec_side: notebooks/swan/boundary/boundspec_side.ipynb
49-
- SCHISM: notebooks/schism/schism_demo.ipynb
48+
- SCHISM:
49+
- notebooks/schism/schism_demo.ipynb
5050
- XBEACH:
5151
- Basic: notebooks/xbeach/example_procedural.ipynb
5252
- Grid: notebooks/xbeach/forcing-demo.ipynb
@@ -55,7 +55,10 @@ nav:
5555
- Grid expanding: notebooks/xbeach/grid-expanding.ipynb
5656
- Wave boundary: notebooks/xbeach/grid-expanding.ipynb
5757
- Bathy boundary: notebooks/xbeach/grid-expanding.ipynb
58-
- backends: notebooks/backends/backend_examples.ipynb
58+
- backends:
59+
- notebooks/backends/backend_examples.ipynb
60+
# - Gallery:
61+
# - Generated Examples: generated/gallery/index.md
5962

6063
theme:
6164
name: material
@@ -87,7 +90,7 @@ theme:
8790
plugins:
8891
- search
8992
- mkdocs-jupyter:
90-
execute: true
93+
execute: false
9194
execute_ignore:
9295
- "*.ipynb"
9396
include_source: True
@@ -111,8 +114,13 @@ plugins:
111114
filters:
112115
- "!^_" # Hide private members by default
113116
# - gallery:
114-
# examples_dirs: examples/notebooks # path to your example scripts
115-
# gallery_dirs: docs/generated/gallery # where to save generated gallery
117+
# examples_dirs:
118+
# - examples/notebooks/rompy_notebooks/common
119+
# - examples/notebooks/rompy_notebooks/backends
120+
# - examples/notebooks/rompy_notebooks/swan
121+
# - examples/notebooks/rompy_notebooks/schism
122+
# gallery_dirs:
123+
# - docs/generated/gallery # where to save generated gallery
116124

117125
markdown_extensions:
118126
- pymdownx.highlight:

0 commit comments

Comments
 (0)