diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/apps/cct.rst | 9 | ||||
| -rw-r--r-- | docs/source/conf.py | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/common.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/cpp_general.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/crs.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/cs.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/datum.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/io.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/metadata.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/operation.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/cpp/util.rst | 2 | ||||
| -rw-r--r-- | docs/source/development/reference/datatypes.rst | 39 | ||||
| -rw-r--r-- | docs/source/development/reference/functions.rst | 50 | ||||
| -rw-r--r-- | docs/source/operations/transformations/deformation.rst | 4 | ||||
| -rw-r--r-- | docs/source/resource_files.rst | 4 | ||||
| -rw-r--r-- | docs/source/usage/differences.rst | 6 |
16 files changed, 119 insertions, 13 deletions
diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst index 33c716fe..c290e1b2 100644 --- a/docs/source/apps/cct.rst +++ b/docs/source/apps/cct.rst @@ -91,6 +91,15 @@ cartesian coordinates) and *Coordinate Transformations*, which are coordinate operations where input and output datums differ (e.g. change of reference frame). +Use of remote grids +******************* + +.. versionadded:: 7.0.0 + +If the :envvar:`PROJ_NETWORK` environment variable is set to ``ON``, +:program:`cct` will attempt to use remote grids stored on CDN (Content +Delivery Network) storage, when they are not available locally. + Examples ******** diff --git a/docs/source/conf.py b/docs/source/conf.py index b9e1fa8a..c2142667 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -376,7 +376,7 @@ texinfo_documents = [ #texinfo_no_detailmenu = False breathe_projects = { - "cpp_stuff":"../build/xml/", + "doxygen_api":"../build/xml/", } import redirects diff --git a/docs/source/development/reference/cpp/common.rst b/docs/source/development/reference/cpp/common.rst index c1a28d37..4e92f6b2 100644 --- a/docs/source/development/reference/cpp/common.rst +++ b/docs/source/development/reference/cpp/common.rst @@ -4,5 +4,5 @@ common namespace ---------------- .. doxygennamespace:: osgeo::proj::common - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/cpp/cpp_general.rst b/docs/source/development/reference/cpp/cpp_general.rst index 3b47d01e..d54daaa8 100644 --- a/docs/source/development/reference/cpp/cpp_general.rst +++ b/docs/source/development/reference/cpp/cpp_general.rst @@ -4,4 +4,4 @@ General documentation --------------------- .. doxygenfile:: general_doc.dox.reworked.h - :project: cpp_stuff + :project: doxygen_api diff --git a/docs/source/development/reference/cpp/crs.rst b/docs/source/development/reference/cpp/crs.rst index 2abea378..f8df118e 100644 --- a/docs/source/development/reference/cpp/crs.rst +++ b/docs/source/development/reference/cpp/crs.rst @@ -4,5 +4,5 @@ crs namespace ------------- .. doxygennamespace:: osgeo::proj::crs - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/cpp/cs.rst b/docs/source/development/reference/cpp/cs.rst index b168213f..376ae6a6 100644 --- a/docs/source/development/reference/cpp/cs.rst +++ b/docs/source/development/reference/cpp/cs.rst @@ -4,5 +4,5 @@ cs namespace ------------ .. doxygennamespace:: osgeo::proj::cs - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/cpp/datum.rst b/docs/source/development/reference/cpp/datum.rst index 1fee5f8a..0a545a68 100644 --- a/docs/source/development/reference/cpp/datum.rst +++ b/docs/source/development/reference/cpp/datum.rst @@ -4,5 +4,5 @@ datum namespace --------------- .. doxygennamespace:: osgeo::proj::datum - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/cpp/io.rst b/docs/source/development/reference/cpp/io.rst index 9da0f680..9729af90 100644 --- a/docs/source/development/reference/cpp/io.rst +++ b/docs/source/development/reference/cpp/io.rst @@ -4,5 +4,5 @@ io namespace ------------ .. doxygennamespace:: osgeo::proj::io - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/cpp/metadata.rst b/docs/source/development/reference/cpp/metadata.rst index b3960122..348627e8 100644 --- a/docs/source/development/reference/cpp/metadata.rst +++ b/docs/source/development/reference/cpp/metadata.rst @@ -4,5 +4,5 @@ metadata namespace ------------------ .. doxygennamespace:: osgeo::proj::metadata - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/cpp/operation.rst b/docs/source/development/reference/cpp/operation.rst index bc3f201d..88096cb8 100644 --- a/docs/source/development/reference/cpp/operation.rst +++ b/docs/source/development/reference/cpp/operation.rst @@ -4,5 +4,5 @@ operation namespace ------------------- .. doxygennamespace:: osgeo::proj::operation - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/cpp/util.rst b/docs/source/development/reference/cpp/util.rst index 1aba2954..bc9676a4 100644 --- a/docs/source/development/reference/cpp/util.rst +++ b/docs/source/development/reference/cpp/util.rst @@ -4,5 +4,5 @@ util namespace -------------- .. doxygennamespace:: osgeo::proj::util - :project: cpp_stuff + :project: doxygen_api :members: diff --git a/docs/source/development/reference/datatypes.rst b/docs/source/development/reference/datatypes.rst index 18bd7efd..7ec17eb1 100644 --- a/docs/source/development/reference/datatypes.rst +++ b/docs/source/development/reference/datatypes.rst @@ -797,11 +797,48 @@ Logging .. versionadded:: 5.1.0 +Setting custom I/O functions +------------------------------------------------------------------------------- + +.. versionadded:: 7.0.0 + +.. doxygenstruct:: PROJ_FILE_API + :project: doxygen_api + :members: + +.. doxygentypedef:: PROJ_FILE_HANDLE + :project: doxygen_api + +.. doxygenenum:: PROJ_OPEN_ACCESS + :project: doxygen_api + + +Network related functionality +------------------------------------------------------------------------------- + +.. versionadded:: 7.0.0 + +.. doxygentypedef:: PROJ_NETWORK_HANDLE + :project: doxygen_api + +.. doxygentypedef:: proj_network_open_cbk_type + :project: doxygen_api + +.. doxygentypedef:: proj_network_close_cbk_type + :project: doxygen_api + +.. doxygentypedef:: proj_network_get_header_value_cbk_type + :project: doxygen_api + +.. doxygentypedef:: proj_network_read_range_type + :project: doxygen_api + + C API for ISO-19111 functionality ------------------------------------------------------------------------------- .. doxygengroup:: iso19111_types - :project: cpp_stuff + :project: doxygen_api :content-only: diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index c010fd13..a2a0c3ae 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -697,6 +697,54 @@ Various :returns: :c:type:`int` 1 if output units is expected in radians, otherwise 0 +Setting custom I/O functions +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. versionadded:: 7.0.0 + +.. doxygenfunction:: proj_context_set_fileapi + :project: doxygen_api + +.. doxygenfunction:: proj_context_set_sqlite3_vfs_name + :project: doxygen_api + + +Network related functionality +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. versionadded:: 7.0.0 + +.. doxygenfunction:: proj_context_set_network_callbacks + :project: doxygen_api + +.. doxygenfunction:: proj_context_set_enable_network + :project: doxygen_api + +.. doxygenfunction:: proj_context_set_url_endpoint + :project: doxygen_api + +.. doxygenfunction:: proj_grid_cache_set_enable + :project: doxygen_api + +.. doxygenfunction:: proj_grid_cache_set_filename + :project: doxygen_api + +.. doxygenfunction:: proj_grid_cache_set_max_size + :project: doxygen_api + +.. doxygenfunction:: proj_grid_cache_set_ttl + :project: doxygen_api + +.. doxygenfunction:: proj_grid_cache_clear + :project: doxygen_api + +.. doxygenfunction:: proj_is_download_needed + :project: doxygen_api + +.. doxygenfunction:: proj_download_file + :project: doxygen_api + + Cleanup ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @@ -727,6 +775,6 @@ which are not of type CRS (can be tested with :c:func:`proj_is_crs`), will return an error when used with functions of this section. .. doxygengroup:: iso19111_functions - :project: cpp_stuff + :project: doxygen_api :content-only: diff --git a/docs/source/operations/transformations/deformation.rst b/docs/source/operations/transformations/deformation.rst index aefda3a6..02924a25 100644 --- a/docs/source/operations/transformations/deformation.rst +++ b/docs/source/operations/transformations/deformation.rst @@ -99,6 +99,8 @@ Parameters Grids for the horizontal component of a deformation model is expected to be in CTable2 format. + .. note:: :option:`+xy_grids` is mutually exclusive with :option:`+grids` + .. option:: +z_grids=<list> Comma-separated list of grids to load. If a grid is prefixed by an `@` the @@ -108,6 +110,8 @@ Parameters Grids for the vertical component of a deformation model is expected to be in either GTX format. + .. note:: :option:`+z_grids` is mutually exclusive with :option:`+grids` + .. option:: +grids=<list> .. versionadded:: 7.0.0 diff --git a/docs/source/resource_files.rst b/docs/source/resource_files.rst index 3684a948..a07d6d6a 100644 --- a/docs/source/resource_files.rst +++ b/docs/source/resource_files.rst @@ -67,6 +67,8 @@ A proj installation includes a SQLite database of transformation information that must be accessible for the library to work properly. The library will print an error if the database can't be found. +.. _proj-ini: + proj.ini ------------------------------------------------------------------------------- @@ -92,7 +94,7 @@ Its default content is: cache_enabled = on - cache_size_MB = 100 + cache_size_MB = 300 cache_ttl_sec = 86400 diff --git a/docs/source/usage/differences.rst b/docs/source/usage/differences.rst index 4d05543a..8fcf51d6 100644 --- a/docs/source/usage/differences.rst +++ b/docs/source/usage/differences.rst @@ -114,3 +114,9 @@ exclusive with :option:`+t_epoch`. :option:`+dt` is used when deformation for a set amount of time is needed and :option:`+t_epoch` is used (in conjunction with the observation time of the input coordinate) when deformation from a specific epoch to the observation time is needed. + +Version 7.0.0 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The value of all path, filenames passed to PROJ through function calls, PROJ +strings or environment variables should be encoded in UTF-8. |
