Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,9 @@ repos:
rev: 6021faba75ed39152339148a1d9e51fda8e9ee2c # 0.12.14
hooks:
- id: uv-lock
- repo: https://github.com/google/addlicense
rev: b289835c0741ba2fb92dd5f61af070e79c69a55e # v1.2.0
hooks:
- id: addlicense
args: ["-c", "European Union", "-l", "apache"]
exclude: '\.(yaml|yml|toml)$'
14 changes: 14 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2026 European Union
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

FROM --platform=linux/amd64 ghcr.io/astral-sh/uv:latest AS uv
FROM --platform=linux/amd64 ubuntu:26.04
COPY --from=uv /uv /uvx /bin/
Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# EDH Docs

Earth Data Hub documentation built with Sphinx.
It uses the Shibuya theme and supports Markdown pages through MyST.
Source code for the Earth Data Hub documentation, built with [Sphinx](https://www.sphinx-doc.org/).
It uses the [Shibuya](https://shibuya.lepture.com/) theme and supports Markdown pages through [MyST](https://mystmd.org/).

Run quality assurance checks:

Expand Down Expand Up @@ -34,3 +34,8 @@ Use these roles for badges matching the Earth Data Hub webportal:
{bdg-deprecated}`Deprecated`
{bdg-geobrowser}`Geobrowser available`
```

## Licenses

- Documentation and other content: [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode)
- Code: [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ dependencies = [
"sphinx-togglebutton>=0.4.5",
"sphinxcontrib-youtube>=1.5.0"
]
license = "Apache-2.0"
license-files = ["LICENSE-CODE"]
name = "edh-docs"
requires-python = ">=3.14"
version = "0.1.0"
Expand Down
14 changes: 14 additions & 0 deletions source/_ext/edh_badges.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2026 European Union
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from docutils import nodes
from sphinx.util.docutils import SphinxRole

Expand Down
14 changes: 14 additions & 0 deletions source/_ext/edh_icons.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2026 European Union
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import json
from pathlib import Path

Expand Down
14 changes: 14 additions & 0 deletions source/_snippets/test_snippet.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2026 European Union
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Examples used by the code snippet test page."""

from collections.abc import Iterable
Expand Down
16 changes: 16 additions & 0 deletions source/_templates/components/meta-opengraph.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

{% with title=title|striptags ~ " - Earth Data Hub Documentation" %}
{% include "!components/meta-opengraph.html" %}
{% endwith %}
16 changes: 16 additions & 0 deletions source/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

{% extends "!layout.html" %}

{% block extrahead %}
Expand Down
16 changes: 16 additions & 0 deletions source/_templates/partials/globaltoc-above.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<div class="edh-docs-sidebar-tools">
{% include "components/searchbox.html" %}
{% include "components/theme-switch.html" %}
Expand Down
16 changes: 16 additions & 0 deletions source/_templates/partials/portal-footer.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<footer class="edh-portal-footer">
<div class="edh-portal-footer__inner">
<a
Expand Down
16 changes: 16 additions & 0 deletions source/_templates/partials/portal-header.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

{% set portal_nav = [
('Getting started', 'getting-started'),
('Catalogue', 'catalogue'),
Expand Down
16 changes: 16 additions & 0 deletions source/_templates/partials/portal-menu-toggle-icons.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<svg class="edh-portal-icon edh-portal-icon--open" viewBox="0 0 24 24" aria-hidden="true">
<path
fill="none"
Expand Down
16 changes: 16 additions & 0 deletions source/_templates/partials/site-foot.html
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

{% include "partials/portal-footer.html" %}
16 changes: 16 additions & 0 deletions source/_templates/partials/site-head.html
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
<!--
Copyright 2026 European Union

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

{% include "partials/portal-header.html" %}
Loading