From 038e3f0a508b7908f16f3517dcb0bc87d6275ab5 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Sat, 31 Mar 2018 00:10:09 +0200 Subject: Use Sphinx option directives to document PROJ options Instead of listing the various projection options in a table we write them as :option: tags instead. This makes it easier to write a more elaborate description of the parameter. Additionally we can create "master"-description of commonly used parameters such as +lon_0 and +k_0 and include them where necessary. This is handled in separate files, one for each common parameters, that are stored in docs/source/operations/options/. --- docs/source/operations/options/ellps.rst | 5 +++++ docs/source/operations/options/k_0.rst | 5 +++++ docs/source/operations/options/lat_0.rst | 5 +++++ docs/source/operations/options/lat_ts.rst | 6 ++++++ docs/source/operations/options/lon_0.rst | 5 +++++ docs/source/operations/options/x_0.rst | 5 +++++ docs/source/operations/options/y_0.rst | 5 +++++ 7 files changed, 36 insertions(+) create mode 100644 docs/source/operations/options/ellps.rst create mode 100644 docs/source/operations/options/k_0.rst create mode 100644 docs/source/operations/options/lat_0.rst create mode 100644 docs/source/operations/options/lat_ts.rst create mode 100644 docs/source/operations/options/lon_0.rst create mode 100644 docs/source/operations/options/x_0.rst create mode 100644 docs/source/operations/options/y_0.rst (limited to 'docs/source/operations/options') diff --git a/docs/source/operations/options/ellps.rst b/docs/source/operations/options/ellps.rst new file mode 100644 index 00000000..af98d377 --- /dev/null +++ b/docs/source/operations/options/ellps.rst @@ -0,0 +1,5 @@ +.. option:: +ellps= + + See :option:`proj -le` for a list of available ellipsoids. + + *Defaults to "WGS84".* diff --git a/docs/source/operations/options/k_0.rst b/docs/source/operations/options/k_0.rst new file mode 100644 index 00000000..7e2947ac --- /dev/null +++ b/docs/source/operations/options/k_0.rst @@ -0,0 +1,5 @@ +.. option:: +k_0= + + Scale factor. Determines scale factor used in the projection. + + *Defaults to 1.0.* diff --git a/docs/source/operations/options/lat_0.rst b/docs/source/operations/options/lat_0.rst new file mode 100644 index 00000000..71e0d190 --- /dev/null +++ b/docs/source/operations/options/lat_0.rst @@ -0,0 +1,5 @@ +.. option:: +lat_0 + + Latitude of projection center. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/lat_ts.rst b/docs/source/operations/options/lat_ts.rst new file mode 100644 index 00000000..65728f4d --- /dev/null +++ b/docs/source/operations/options/lat_ts.rst @@ -0,0 +1,6 @@ +.. option:: +lat_ts= + + Latitude of true scale. Defines the latitude where scale is not distorted. + Takes precedence over ``+k_0`` if both options are used together. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/lon_0.rst b/docs/source/operations/options/lon_0.rst new file mode 100644 index 00000000..9bc4458f --- /dev/null +++ b/docs/source/operations/options/lon_0.rst @@ -0,0 +1,5 @@ +.. option:: +lon_0 + + Longitude of projection center. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/x_0.rst b/docs/source/operations/options/x_0.rst new file mode 100644 index 00000000..ed4020d8 --- /dev/null +++ b/docs/source/operations/options/x_0.rst @@ -0,0 +1,5 @@ +.. option:: +x_0= + + False easting. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/y_0.rst b/docs/source/operations/options/y_0.rst new file mode 100644 index 00000000..d7db658a --- /dev/null +++ b/docs/source/operations/options/y_0.rst @@ -0,0 +1,5 @@ +.. option:: +y_0= + + False northing. + + *Defaults to 0.0.* -- cgit v1.2.3