Skip to content

Commit

Permalink
minor doc sweep (geopython#1864)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis authored Dec 8, 2024
1 parent 0cf470a commit 2262696
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The ``metadata`` section provides settings for overall service metadata and desc
- api
keywords_type: theme # keyword type as per the ISO 19115 MD_KeywordTypeCode codelist. Accepted values are discipline, temporal, place, theme, stratum
terms_of_service: https://creativecommons.org/licenses/by/4.0/ # terms of service
url: http://example.org # informative URL about the service
url: https://example.org # informative URL about the service
license: # licensing details
name: CC-BY 4.0 license
url: https://creativecommons.org/licenses/by/4.0/
Expand Down Expand Up @@ -648,5 +648,5 @@ At this point, you have the configuration ready to administer the server.
.. _`JSON-LD`: https://json-ld.org
.. _`Google Structured Data Testing Tool`: https://search.google.com/structured-data/testing-tool#url=https%3A%2F%2Fdemo.pygeoapi.io%2Fmaster
.. _`Google Dataset Search`: https://developers.google.com/search/docs/appearance/structured-data/dataset
.. _RotatingFileHandler: http://docs.python.org/3/library/logging.handlers.html#rotatingfilehandler
.. _TimedRotatingFileHandler: http://docs.python.org/3/library/logging.handlers.html#timedrotatingfilehandler
.. _RotatingFileHandler: https://docs.python.org/3/library/logging.handlers.html#rotatingfilehandler
.. _TimedRotatingFileHandler: https://docs.python.org/3/library/logging.handlers.html#timedrotatingfilehandler
2 changes: 1 addition & 1 deletion docs/source/data-publishing/ogcapi-coverages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Data access examples
``.../coverage`` queries which return an alternative representation to CoverageJSON (which prompt a download)
will have the response filename matching the collection name and appropriate file extension (e.g. ``my-dataset.nc``)

.. _`OGC API - Coverages`: https://github.com/opengeospatial/ogcapi-coverages
.. _`OGC API - Coverages`: https://ogcapi.ogc.org/coverages
.. _`Rasterio`: https://rasterio.readthedocs.io
.. _`Xarray`: https://docs.xarray.dev/en/stable
.. _`NetCDF`: https://en.wikipedia.org/wiki/NetCDF
Expand Down
4 changes: 1 addition & 3 deletions docs/source/data-publishing/ogcapi-edr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,4 @@ Data access examples
.. _`NetCDF`: https://en.wikipedia.org/wiki/NetCDF
.. _`Zarr`: https://zarr.readthedocs.io/en/stable
.. _`pyproj.CRS.from_user_input`: https://pyproj4.github.io/pyproj/stable/api/crs/coordinate_system.html#pyproj.crs.CoordinateSystem.from_user_input


.. _`OGC Environmental Data Retrieval (EDR) (API)`: https://github.com/opengeospatial/ogcapi-coverages
.. _`OGC Environmental Data Retrieval (EDR) (API)`: https://ogcapi.ogc.org/edr
2 changes: 1 addition & 1 deletion docs/source/data-publishing/ogcapi-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -813,7 +813,7 @@ Data access examples
.. _`Feature Service`: https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-feature-service-.htm
.. _`Map Service`: https://enterprise.arcgis.com/en/server/latest/publish-services/windows/what-is-a-map-service.htm
.. _`Google Cloud SQL`: https://cloud.google.com/sql
.. _`OGC API - Features`: https://www.ogc.org/standards/ogcapi-features
.. _`OGC API - Features`: https://ogcapi.ogc.org/features
.. _`Socrata Open Data API (SODA)`: https://dev.socrata.com
.. _`sodapy`: https://github.com/xmunoz/sodapy
.. _`Tabledap`: https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html
Expand Down
12 changes: 6 additions & 6 deletions docs/source/data-publishing/ogcapi-tiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@ Following code block shows how to configure pygeoapi to read Mapbox vector tiles
- type: tile
name: MVT-proxy
data: http://localhost:3000/ne_50m_admin_0_countries/{z}/{x}/{y}
options:
zoom:
min: 0
max: 15
schemes:
options:
zoom:
min: 0
max: 15
schemes:
- WebMercatorQuad
format:
name: pbf
Expand Down Expand Up @@ -183,7 +183,7 @@ Data access examples



.. _`OGC API - Tiles`: https://github.com/opengeospatial/ogcapi-tiles
.. _`OGC API - Tiles`: https://ogcapi.ogc.org/tiles
.. _`tippecanoe`: https://github.com/mapbox/tippecanoe
.. _`Elasticsearch`: https://www.elastic.co/
.. _`Mapbox Vector Tiles`: https://docs.mapbox.com/data/tilesets/guides/vector-tiles-introduction/
2 changes: 1 addition & 1 deletion docs/source/data-publishing/stac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ The example below shows the content of a file named *arcticdem-frontiere-0.json*
],
"assets": {
"image": {
"href": "http://absolute/path/to/the/ressource/arcticdem-frontiere-0.tif",
"href": "https://example.com/path/to/resource/arcticdem-frontiere-0.tif",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"roles": []
}
Expand Down
6 changes: 3 additions & 3 deletions docs/source/language.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ End user guide
There are 2 ways to affect the language of the results returned by pygeoapi, both for the HTML and JSON(-LD) formats:

1. After the requested pygeoapi URL, append a ``lang=<code>`` query parameter, where ``<code>`` should be replaced by a well-known language code.
This can be an ISO 639-1 code (e.g. `de` for German), optionally accompanied by an ISO 3166-1 alpha-2 country code (e.g. `de-CH` for Swiss-German).
Please refer to this `W3C article <https://www.w3.org/International/articles/language-tags/>`_ for more information or
this `list of language codes <http://www.lingoes.net/en/translator/langcode.htm>`_ for more examples.
This can be an `ISO 639-1 code <https://www.loc.gov/standards/iso639-2/php/code_list.php>`_ (e.g. `de` for German), optionally accompanied by an `ISO 3166-1 alpha-2 country code <https://www.iso.org/obp/ui/#search>`_ (e.g. `de-CH` for Swiss-German).

Please refer to this `W3C article <https://www.w3.org/International/articles/language-tags/>`_ for more information.
Another option is to send a complex definition with quality weights (e.g. `de-CH, de;q=0.9, en;q=0.8, fr;q=0.7, \*;q=0.5`).
pygeoapi will then figure out the best match for the requested language.

Expand Down

0 comments on commit 2262696

Please sign in to comment.