Skip to content

Commit a076fa0

Browse files
committed
fixes
1 parent 5060d8b commit a076fa0

File tree

6 files changed

+23
-9
lines changed

6 files changed

+23
-9
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1+
site/
12
.idea/
2-
3-
# Jupyter Notebook
43
.ipynb_checkpoints

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,8 @@
33
# DeepESDL documentation
44

55
This repository contains the source files for the DeepESDL documentation.
6+
7+
8+
## Building the docs
9+
10+
$ conda install -c conda-forge mkdocs mkapi

docs/design/overview.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# DeepESDL Design Overview
2+
3+
1. [Context](context.md)
4+
2. [Architecture](architecture.md)
5+
3. [Hub](hub.md)
6+
4. [Services and Tools](services-and-tools.md)
7+

docs/design/services-and-tools.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,5 +167,7 @@ detection on time series.
167167
The toolkit is currently for Python only, but Julia will also be
168168
considered to address a small but growing community of data scientists.
169169

170+
<!--
170171
Please refer to the [ML Tools Documentation](../ml-tools/index.md)
171172
for details.
173+
-->

docs/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ code, and publish results. Special emphasize is put on improving the support
1212
for machine learning and artificial intelligence approaches, which includes
1313
the preparation of AI-ready datasets, providing a programming environment
1414
with relevant libraries and packages, and the resources to execute processing
15-
pipelines. Please visit our webportal for more information and access to the
16-
lab: [www.earthsystemdatalab.net](www.earthsystemdatalab.net).
15+
pipelines. For more information and access to the lab please visit the
16+
[DeepESDL website](https://www.earthsystemdatalab.net/).
1717

1818
The DeepESDL documentation contains:
1919

20-
- The [User Guide](guide/overview.md) for all DeepESDL services – the starting
21-
point for new users and the reference for any technical questions.
22-
- An overview of [public, pre-generated data cubes](datasets/datasets.md)
23-
available in DeepESDL with detailed metadata and specifications.
24-
- A [description of DeepESDL’s architecture](design/index.md).
20+
* The [User Guide](guide/overview.md) for all DeepESDL services.
21+
This is the starting point for new users.
22+
* An overview of [public, pre-generated data cubes](datasets/datasets.md)
23+
available in DeepESDL with detailed metadata and specifications.
24+
* A [description of DeepESDL’s architecture](design/overview.md).

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
site_name: DeepESDL Documentation
22
site_url: https://deepesdl.readthedocs.io
33
repo_url: https://github.com/deepesdl/deepesdl-doc
4+
edit_uri: edit/main/docs
45
copyright: Copyright © 2022 by the DeepESDL Team
56
theme: readthedocs # alternative: mkdocs
67

0 commit comments

Comments
 (0)