EDH Docs

Source code for the Earth Data Hub documentation, built with Sphinx. It uses the Shibuya theme and supports Markdown pages through MyST.

Run quality assurance checks:

make qa

Build the documentation locally:

make html

Open the generated HTML or serve it:

make serve

Then go to http://localhost:8000.

Markdown for LLMs

Every page is also published as Markdown (page.md next to page.html), together with llms.txt and llms-full.txt, by sphinx-llm. The "Use with AI" links use DOCUMENTATION_PORTAL_URL. To try them locally, build with:

make html-llm

Custom badges

Use these roles for badges matching the Earth Data Hub webportal:

{bdg-restricted}`Restricted`
{bdg-edh-keyword}`EDH keyword`
{bdg-draft}`Draft`
{bdg-deprecated}`Deprecated`
{bdg-geobrowser}`Geobrowser available`

Required envars to properly build the documentation

• READTHEDOCS_CANONICAL_URL:
  Root of the documentation site (can also be a root absolute path). This is used by the sphinx-notfound-page plugin!
• BASE_URL:
  external full URL to the EDH portal
• DATASTORE_INTERNAL_HOST:
  Main EDH access domain (by default data.earthdatahub.destine.eu)
• DATASTORE_HOST:
  Alternative EDH access URL (required for restricted datasets, by default api.earthdatahub.destine.eu)
• DOCUMENTATION_PORTAL_URL:
  Public URL to the documentation portal (by default https://earthdatahub.destine.eu/docs)
• PRIVATE_TEST_DATASET_PATH:
  Path to demo dataset to be displayed in quickstart guide (must be equal to same dataset on the web portal, defaults to /private/test-dataset-v1.zarr)

Licenses

• Documentation and other content: Creative Commons Attribution 4.0 International Public License
• Code: Apache License, Version 2.0