Skip to content

This is the documenation source for the dataset API provided by Geosphere Austria

Notifications You must be signed in to change notification settings

Geosphere-Austria/dataset-api-docs

Repository files navigation

dataset-api-docs

❗ The Geosphere Austria data API has moved to https://dataset.api.hub.geosphere.at. The API at https://dataset.api.hub.zamg.ac.at is still available but will receive maintenance updates only. We recommend to use the https://dataset.api.hub.geosphere.at from now on. For more details see the documentations changelog.

This is the documentation for the data-api provided by Geosphere Austria.

Feedback

If you are facing issues with the API or if you have suggestions, please open a new issue.

If your request better fits in an e-mail, please contact datahub.feedback@geosphere.at

Build

The documentation is written in Sphinx together with MyST Markdown as a markup language.

The source code for the documentation is located in the src/ folder. The documentation build will be located in the build/ folder.

Create a python environment

make python-venv

Build the docs

make build

If you want to start a server which builds and reloads the docs automatically upon changes in the source files run

make auto-reload-server

The documentation will be available at http://localhost:8000

Containerized Build

You can build a container image with the documentation via

make container-image

and run the image with

make run-container

The containerized documentation is available at http://localhost:8000/v1/docs