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 From 970d708ff9d796f7d9ec00b22023e835fbdc7f2d Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Mon, 30 Apr 2018 22:42:59 +0200 Subject: Refactor operation doc pages Extended the use of the :option: directive to all currently written operation doc pages. In the process several more default parameters were added for easy inclusion in other doc pages. Expanded the info tables for each operation with "domain", "alias", "input type" and "output type". Corrected various errors along the way. Mainly formatting errors and references to invalid parameters such as +sym in hatano. --- docs/source/operations/options/R.rst | 4 ++++ docs/source/operations/options/h.rst | 5 +++++ docs/source/operations/options/lat_0.rst | 2 +- docs/source/operations/options/lat_1.rst | 5 +++++ docs/source/operations/options/lat_2.rst | 5 +++++ docs/source/operations/options/lon_0.rst | 2 +- 6 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 docs/source/operations/options/R.rst create mode 100644 docs/source/operations/options/h.rst create mode 100644 docs/source/operations/options/lat_1.rst create mode 100644 docs/source/operations/options/lat_2.rst (limited to 'docs/source/operations/options') diff --git a/docs/source/operations/options/R.rst b/docs/source/operations/options/R.rst new file mode 100644 index 00000000..1d4af03a --- /dev/null +++ b/docs/source/operations/options/R.rst @@ -0,0 +1,4 @@ +.. option:: +R= + + Radius of the sphere given in meters. If used in conjunction with ``+ellps`` + ``+R`` takes precedence. diff --git a/docs/source/operations/options/h.rst b/docs/source/operations/options/h.rst new file mode 100644 index 00000000..b41bcada --- /dev/null +++ b/docs/source/operations/options/h.rst @@ -0,0 +1,5 @@ +.. option:: +h= + + Height of the view point above the Earth and must be in the same units as + the radius of the sphere or semimajor axis of the ellipsoid. + diff --git a/docs/source/operations/options/lat_0.rst b/docs/source/operations/options/lat_0.rst index 71e0d190..b8da9cdc 100644 --- a/docs/source/operations/options/lat_0.rst +++ b/docs/source/operations/options/lat_0.rst @@ -1,4 +1,4 @@ -.. option:: +lat_0 +.. option:: +lat_0= Latitude of projection center. diff --git a/docs/source/operations/options/lat_1.rst b/docs/source/operations/options/lat_1.rst new file mode 100644 index 00000000..dee60ee0 --- /dev/null +++ b/docs/source/operations/options/lat_1.rst @@ -0,0 +1,5 @@ +.. option:: +lat_1= + + First standard parallel. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/lat_2.rst b/docs/source/operations/options/lat_2.rst new file mode 100644 index 00000000..29e739a6 --- /dev/null +++ b/docs/source/operations/options/lat_2.rst @@ -0,0 +1,5 @@ +.. option:: +lat_2= + + Second standard parallel. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/lon_0.rst b/docs/source/operations/options/lon_0.rst index 9bc4458f..143a7b84 100644 --- a/docs/source/operations/options/lon_0.rst +++ b/docs/source/operations/options/lon_0.rst @@ -1,4 +1,4 @@ -.. option:: +lon_0 +.. option:: +lon_0= Longitude of projection center. -- cgit v1.2.3