From a2f807b330f1cec10b2e3484d296ed73ca040ca2 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Tue, 3 Apr 2018 11:53:22 +0200 Subject: Update documentation for 5.0.1 --- docs/source/conf.py | 2 +- docs/source/download.rst | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) (limited to 'docs/source') diff --git a/docs/source/conf.py b/docs/source/conf.py index a269a7d9..fa1de3ed 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -58,7 +58,7 @@ author = u'Gerald Evenden, Frank Warmerdam, and others' # built documents. # # The short X.Y version. -version = u'5.0.0' +version = u'5.0.1' # The full version, including alpha/beta/rc tags. release = u'5.0.0' diff --git a/docs/source/download.rst b/docs/source/download.rst index 784bb756..d7c60d63 100644 --- a/docs/source/download.rst +++ b/docs/source/download.rst @@ -15,7 +15,7 @@ Release Notes Current Release -------------------------------------------------------------------------------- -* **2018-03-01** `proj-5.0.0.tar.gz`_ (`md5`_) +* **2018-04-01** `proj-5.0.1.tar.gz`_ (`md5`_) * **2018-03-01** `proj-datumgrid-1.7.zip`_ * **2018-03-01** `proj-datumgrid-europe-1.0.zip`_ * **2018-03-01** `proj-datumgrid-north-america-1.0.zip`_ @@ -24,12 +24,14 @@ Current Release Past Releases -------------------------------------------------------------------------------- +* **2018-03-01** `proj-5.0.0.tar.gz`_ * **2016-09-02** `proj-4.9.3.tar.gz`_ * **2015-09-13** `proj-4.9.2.tar.gz`_ * **2015-03-04** `proj-4.9.1.tar.gz`_ * **2016-09-11** `proj-datumgrid-1.6.zip`_ +.. _`proj-5.0.1.tar.gz`: http://download.osgeo.org/proj/proj-5.0.1.tar.gz .. _`proj-5.0.0.tar.gz`: http://download.osgeo.org/proj/proj-5.0.0.tar.gz .. _`proj-4.9.1.tar.gz`: http://download.osgeo.org/proj/proj-4.9.1.tar.gz .. _`proj-4.9.2.tar.gz`: http://download.osgeo.org/proj/proj-4.9.2.tar.gz @@ -39,7 +41,7 @@ Past Releases .. _`proj-datumgrid-europe-1.0.zip`: http://download.osgeo.org/proj/proj-datumgrid-europe-1.0.zip .. _`proj-datumgrid-north-america-1.0.zip`: http://download.osgeo.org/proj/proj-datumgrid-north-america-1.0.zip .. _`proj-datumgrid-oceania-1.0.zip`: http://download.osgeo.org/proj/proj-datumgrid-oceania-1.0.zip -.. _`md5`: http://download.osgeo.org/proj/proj-5.0.0.tar.gz.md5 +.. _`md5`: http://download.osgeo.org/proj/proj-5.0.1.tar.gz.md5 Binaries -------------------------------------------------------------------------------- -- cgit v1.2.3 From fa2fcad163b8068d418fba1924a19f35b071d7d3 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Tue, 3 Apr 2018 11:54:36 +0200 Subject: Add yyyymmdd temporal unit to unitconvert docs --- docs/source/operations/conversions/unitconvert.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/source') diff --git a/docs/source/operations/conversions/unitconvert.rst b/docs/source/operations/conversions/unitconvert.rst index 50ac832c..bc422afb 100644 --- a/docs/source/operations/conversions/unitconvert.rst +++ b/docs/source/operations/conversions/unitconvert.rst @@ -109,4 +109,6 @@ In the table below all time units supported by PROJ is listed. +--------------+-----------------------------+ | gps_week | GPS Week | +--------------+-----------------------------+ +| yyyymmdd | Date in yyyymmdd format | ++--------------+-----------------------------+ -- cgit v1.2.3 From 053b7e3e45b0ce60cde462a9d590afd6d4682cd1 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Tue, 3 Apr 2018 19:32:53 +0200 Subject: Add 'echo' and 'skip' command to gie docs --- docs/source/apps/gie.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to 'docs/source') diff --git a/docs/source/apps/gie.rst b/docs/source/apps/gie.rst index eee0e22d..777c5833 100644 --- a/docs/source/apps/gie.rst +++ b/docs/source/apps/gie.rst @@ -260,6 +260,46 @@ gie command language See ``gie -l`` for a list of error codes that can be ignored. +.. option:: echo + + Add user defined text to the output stream. See the example below. + + .. code-block:: console + + + echo ** Mercator projection tests ** + operation +proj=merc + accept 0 0 + expect 0 0 + + + which returns + + .. code-block:: console + + ------------------------------------------------------------------------------- + Reading file 'test.gie' + ** Mercator projection test ** + ------------------------------------------------------------------------------- + total: 1 tests succeeded, 0 tests skipped, 0 tests failed. + ------------------------------------------------------------------------------- + +.. option:: skip + + Skip any test after the first occurence of :option:`skip`. In the example below only + the first test will be performed. The second test is skipped. This feature is mostly + relevant for debugging when writing new test cases. + + .. code-block:: console + + + operation proj=merc + accept 0 0 + expect 0 0 + skip + accept 0 1 + expect 0 110579.9 + Background ********** -- cgit v1.2.3 From 23415f832cc74b56958f90900d8b55b356678a88 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Sun, 8 Apr 2018 17:26:55 +0200 Subject: Override style of Sphinx versionmodified directives so they stand out more clearly in the text --- docs/source/_static/theme_overrides.css | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'docs/source') diff --git a/docs/source/_static/theme_overrides.css b/docs/source/_static/theme_overrides.css index b82d2881..4e612939 100644 --- a/docs/source/_static/theme_overrides.css +++ b/docs/source/_static/theme_overrides.css @@ -55,3 +55,16 @@ div.math { overflow-x: auto; overflow-y: hidden; } + +/* Override style of versionmodified directives */ +.versionadded { + font-style: italic; +} + +.versionchanged { + font-style: italic; +} + +.deprecated { + font-style: italic; +} -- cgit v1.2.3 From c2d5216b02705f5b1432d91aa1e6bef7f23d0ce6 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Mon, 9 Apr 2018 02:02:26 +0200 Subject: Fix bad example in eqc docs --- docs/source/operations/projections/eqc.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/source') diff --git a/docs/source/operations/projections/eqc.rst b/docs/source/operations/projections/eqc.rst index be431977..5833bd61 100644 --- a/docs/source/operations/projections/eqc.rst +++ b/docs/source/operations/projections/eqc.rst @@ -64,9 +64,8 @@ Example using EPSG 32662 (WGS84 Plate Carrée):: Example using Plate Carrée projection with true scale at latitude 30° and central meridian 90°W:: - $ echo -88 30 | proj +proj=eqc +lat_ts=30 +lat_0=90w - -8483684.61 13358338.90 - + $ echo -88 30 | proj +proj=eqc +lat_ts=30 +lon_0=90w + 192811.01 3339584.72 Mathematical definition ####################### -- cgit v1.2.3 From a4f4228d055aac7bb66f77b10fe5128e69e9e09a Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Sat, 7 Apr 2018 13:41:12 +0200 Subject: Add webmerc projection --- docs/source/operations/projections/index.rst | 1 + docs/source/operations/projections/webmerc.rst | 78 ++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) create mode 100644 docs/source/operations/projections/webmerc.rst (limited to 'docs/source') diff --git a/docs/source/operations/projections/index.rst b/docs/source/operations/projections/index.rst index 9255d9fd..77decd6c 100644 --- a/docs/source/operations/projections/index.rst +++ b/docs/source/operations/projections/index.rst @@ -141,6 +141,7 @@ Projections map the spherical 3D space to a flat 2D space. wag5 wag6 wag7 + webmerc weren wink1 wink2 diff --git a/docs/source/operations/projections/webmerc.rst b/docs/source/operations/projections/webmerc.rst new file mode 100644 index 00000000..0c465afc --- /dev/null +++ b/docs/source/operations/projections/webmerc.rst @@ -0,0 +1,78 @@ +.. _webmerc: + +******************************************************************************** +Web Mercator / Pseudo Mercator +******************************************************************************** + +The Web Mercator / Pseudo Mercator projection is a cylindrical map projection. +This is a variant of the regular :ref:`merc` projection, except that the computation +is done on a sphere, using the semi-major axis of the ellipsoid. + +From `Wikipedia `_: + + This projection is widely used by the Web Mercator, Google Web Mercator, + Spherical Mercator, WGS 84 Web Mercator[1] or WGS 84/Pseudo-Mercator is a + variant of the Mercator projection and is the de facto standard for Web + mapping applications. [...] + It is used by virtually all major online map providers [...] + Its official EPSG identifier is EPSG:3857, although others have been used + historically. + + ++---------------------+----------------------------------------------------------+ +| **Classification** | Cylindrical (non conformant if used with ellipsoid) | ++---------------------+----------------------------------------------------------+ +| **Version** | Added in proj 5.1.0 | ++---------------------+----------------------------------------------------------+ +| **Available forms** | Forward and inverse, spherical projection | ++---------------------+----------------------------------------------------------+ +| **Defined area** | Global, but best used near the equator | ++---------------------+----------------------------------------------------------+ +| **Options** | Neither lat_0, lon_0, lat_ts or k_0 should be used. | ++---------------------+----------------------------------------------------------+ + +Usage +######## + +Example:: + + $ echo 2 49 | proj +proj=webmerc +datum=WGS84 + 222638.98 6274861.39 + +Mathematical definition +####################### + +The formulas describing the Mercator projection are all taken from G. Evenden's libproj manuals [Evenden2005]_. + +Forward projection +================== + +.. math:: + + x = \lambda + +.. math:: + + y = \ln \left[ \tan \left(\frac{\pi}{4} + \frac{\phi}{2} \right) \right] + + +Inverse projection +================== + +.. math:: + + \lambda = {x} + +.. math:: + + \phi = \frac{\pi}{2} - 2 \arctan \left[ e^{-y} \right] + + + +Further reading +############### + +#. `Wikipedia `_ + + + -- cgit v1.2.3 From 4731bc4a3438b04574545a78ac52ba631e0504c4 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Mon, 9 Apr 2018 22:27:59 +0200 Subject: Add description of projection and +lat_b parameter --- docs/source/operations/projections/airy.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'docs/source') diff --git a/docs/source/operations/projections/airy.rst b/docs/source/operations/projections/airy.rst index d2730592..eefda4e9 100644 --- a/docs/source/operations/projections/airy.rst +++ b/docs/source/operations/projections/airy.rst @@ -3,6 +3,11 @@ ******************************************************************************** Airy ******************************************************************************** + +The Airy projection is an azimuthal minimum error projection for the region +within the small or great circle defined by an angular distance, +:math:`\phi_b`, from the tangency point of the plane :math:`( \lambda_0, \phi_0 )`. + +---------------------+----------------------------------------------------------+ | **Classification** | | +---------------------+----------------------------------------------------------+ @@ -14,7 +19,10 @@ Airy +---------------------+----------------------------------------------------------+ | **Options** | +---------------------+----------------------------------------------------------+ -| `+lat_b` | | +| `+lat_b` | Angular distance from tangency point of the plane | +| | :math:`( \lambda_0, \phi_0 )` where the error is kept at | +| | minimum. Defaults to :math:`90^{\circ}` which is | +| | suitable for hemispherical maps. | +---------------------+----------------------------------------------------------+ | `+no_cut` | Do not cut at hemisphere limit | +---------------------+----------------------------------------------------------+ -- cgit v1.2.3 From 75764c42c96aec7d3181b2b23ac4c2400ee8a427 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Wed, 11 Apr 2018 23:11:23 +0200 Subject: Update docs for nsper --- docs/source/operations/projections/nsper.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'docs/source') diff --git a/docs/source/operations/projections/nsper.rst b/docs/source/operations/projections/nsper.rst index 4a8651fc..3f46f2b4 100644 --- a/docs/source/operations/projections/nsper.rst +++ b/docs/source/operations/projections/nsper.rst @@ -4,7 +4,28 @@ Near-sided perspective ******************************************************************************** +The near-sided perspective projection simulates a view from a height +:math:`h` similar to how a satellite in orbit would see it. + ++---------------------+-------------------------------------------------------------+ +| **Classification** | Azimuthal. Neither conformal nor equal area. | ++---------------------+-------------------------------------------------------------+ +| **Available forms** | Forward and inverse spherical projection | ++---------------------+-------------------------------------------------------------+ +| **Defined area** | Global, although for one hemisphere at a time. | ++---------------------+-------------------------------------------------------------+ +| **Options** | ++---------------------+-------------------------------------------------------------+ +| `+h` | Height of the view point above the Earth and must be in | +| | the same units as the radius of the sphere. Required. | ++---------------------+-------------------------------------------------------------| +| `+lat_0` | Latitude (in degrees) of the view position. Defaults to 0. | ++---------------------+-------------------------------------------------------------+ +| `+lon_0` | Longitude (in degrees) of the view position. Defaults to 0. | ++---------------------+-------------------------------------------------------------+ + + .. image:: ./images/nsper.png :scale: 50% - :alt: Near-sided perspective + :alt: Near-sided perspective -- cgit v1.2.3 From f9d81882c473310e5a1785bdbee06d8658998051 Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Tue, 3 Apr 2018 17:45:23 +0200 Subject: Add --skip-lines option to cct With this it is possible to skip the header when transforming coordinates from a file. --- docs/source/apps/cct.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs/source') diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst index dc2944f2..20aec06c 100644 --- a/docs/source/apps/cct.rst +++ b/docs/source/apps/cct.rst @@ -44,6 +44,13 @@ The following control parameters can appear in any order: Specify a fixed observation height to be used for all input data. +.. option:: s , --skip-lines= + + .. versionadded:: 5.1.0 + + Skip the first *n* lines of input. This applies to any kind of input, wether + it comes from ``STDIN``, a file or interactive user input. + .. option:: -v, --verbose Write non-essential, but potentially useful, information to stderr. -- cgit v1.2.3 From 2f082b70cbdafdea49bb123e027406089e7ad65b Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Thu, 5 Apr 2018 19:25:31 +0000 Subject: Move logging functions to proj.h API --- docs/source/development/reference/datatypes.rst | 50 +++++++++++++++++++++++++ docs/source/development/reference/functions.rst | 28 ++++++++++++++ 2 files changed, 78 insertions(+) (limited to 'docs/source') diff --git a/docs/source/development/reference/datatypes.rst b/docs/source/development/reference/datatypes.rst index 8966923a..2a335a15 100644 --- a/docs/source/development/reference/datatypes.rst +++ b/docs/source/development/reference/datatypes.rst @@ -744,3 +744,53 @@ Info structures .. c:member:: char PJ_INIT_INFO.lastupdate Date of last update of the init-file. + + +Logging +------------------------------------------------------------------------------- + +.. c:type:: PJ_LOG_LEVEL + + Enum of logging levels in PROJ. Used to set the logging level in PROJ. + Usually using :c:func:`proj_log_level`. + + .. c:member:: PJ_LOG_NONE + + Don't log anything. + + .. c:member:: PJ_LOG_ERROR + + Log only errors. + + .. c:member:: PJ_LOG_DEBUG + + Log errors and additional debug information. + + .. c:member:: PJ_LOG_TRACE + + Highest logging level. Log everything including very detailed debug + information. + + .. c:member:: PJ_LOG_TELL + + Special logging level that when used in :c:func:`proj_log_level` + will return the current logging level set in PROJ. + + .. versionadded:: 5.1.0 + +.. c:type:: PJ_LOG_FUNC + + Function prototype for the logging function used by PROJ. + Defined as + + .. code-block:: C + + typedef void (*PJ_LOG_FUNCTION)(void *, int, const char *); + + where the :c:type:`void` pointer references a data structure used by the + calling application, the :c:type:`int` is used to set the logging level + and the :c:type:`const char` pointer is the string that will be logged + by the function. + + + .. versionadded:: 5.1.0 diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index 3d141ae2..52f801e5 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -276,6 +276,34 @@ Change the error-state of :c:data:`P` to `err`. .. note:: Available from version 5.1.0. + +Logging +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. c:function:: PJ_LOG_LEVEL proj_log_level (PJ_CONTEXT *ctx, PJ_LOG_LEVEL level) + + Get and set logging level for a given context. Changes the log level to + :c:data:`level` and returns the previous logging level. If called with + :c:data:`level` set to :c:type:`PJ_LOG_TELL` the function returns the current + logging level without changing it. + + :param PJ_CONTEXT* ctx: Threading context. + :param PJ_LOG_LEVEL level: New logging level. + + :returns: :c:type:`PJ_LOG_LEVEL` + + .. versionadded:: 5.1.0 + +.. c:function:: void proj_log_func (PJ_CONTEXT *ctx, void *app_data, PJ_LOG_FUNCTION logf) + + Override the internal log function of PROJ. + + :param PJ_CONTEXT* ctx: Threading context. + :param void* app_data: Pointer to data structure used by the calling application. + :param PJ_LOG_FUNCTION logf: Log function that overrides the PROJ log function. + + .. versionadded:: 5.1.0 + Info functions ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -- cgit v1.2.3 From b0fa1a508d4827032f81ae03d29a54e3091ae47b Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Sun, 15 Apr 2018 18:41:48 +0200 Subject: Update aeqd docs with note of area of use for +guam option --- docs/source/operations/projections/aeqd.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/source') diff --git a/docs/source/operations/projections/aeqd.rst b/docs/source/operations/projections/aeqd.rst index 32165e49..d4baa8b6 100644 --- a/docs/source/operations/projections/aeqd.rst +++ b/docs/source/operations/projections/aeqd.rst @@ -12,7 +12,10 @@ Azimuthal Equidistant +---------------------+----------------------------------------------------------+ | **Options** | +---------------------+----------------------------------------------------------+ -| `+guam` | Use Guam elliptical formulas. Defaults to false. | +| `+guam` | Use Guam elliptical formulas. Only accurate near the | +| | Island of Guam (:math:`\lambda\approx 144.5^{\circ}`, | +| | :math:`\phi\approx 13.5^{\circ}`) | +| | Defaults to false. | +---------------------+----------------------------------------------------------+ -- cgit v1.2.3 From 24af7a3f5d459bb6495ee61db88ce54b6eceacb3 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sun, 22 Apr 2018 20:56:06 +1200 Subject: Rename various Sphinx docs from PROJ.4 to PROJ This also includes the PDF manual, Qt help file, man pages, etc. --- docs/source/conf.py | 12 ++++++------ docs/source/index.rst | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/source') diff --git a/docs/source/conf.py b/docs/source/conf.py index fa1de3ed..ae65995c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# PROJ.4 documentation build configuration file, created by +# PROJ documentation build configuration file, created by # sphinx-quickstart on Wed Feb 24 10:47:15 2016. # # This file is execfile()d with the current directory set to its @@ -48,7 +48,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'PROJ.4' +project = u'PROJ' now = datetime.datetime.now() copyright = u'1983-{0}'.format(now.year) author = u'Gerald Evenden, Frank Warmerdam, and others' @@ -211,7 +211,7 @@ html_show_sourcelink = False #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'proj4doc' +htmlhelp_basename = 'projdoc' # -- Options for LaTeX output --------------------------------------------- @@ -238,7 +238,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'proj4.tex', u'PROJ.4 Documentation', + (master_doc, 'proj.tex', u'PROJ Documentation', u'Gerald Evenden', 'manual'), ] @@ -315,8 +315,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'proj4', u'PROJ.4 Documentation', - author, 'proj4', 'One line description of project.', + (master_doc, 'proj', u'PROJ Documentation', + author, 'proj', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/source/index.rst b/docs/source/index.rst index 3f02de3b..9ed64c02 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,7 +26,7 @@ Coverage |coverals| :target: https://coveralls.io/r/OSGeo/proj.4?branch=master Full documentation is available as a single PDF at -https://raw.githubusercontent.com/OSGeo/proj.4/gh-pages/proj4.pdf +https://raw.githubusercontent.com/OSGeo/proj.4/gh-pages/proj.pdf Documentation ================= -- cgit v1.2.3 From 656703a278a30a8745a7df08f7d7dffbc057d4b3 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sun, 22 Apr 2018 21:42:41 +1200 Subject: Improve grammar and use hyphen-minus for latex --- docs/source/geodesic.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/source') diff --git a/docs/source/geodesic.rst b/docs/source/geodesic.rst index d54212ca..8f6f5bbe 100644 --- a/docs/source/geodesic.rst +++ b/docs/source/geodesic.rst @@ -10,8 +10,8 @@ Geodesic calculations Introduction ------------ -Consider a ellipsoid of revolution with equatorial radius :math:`a`, polar -semi-axis :math:`b`, and flattening :math:`f=(a−b)/a`. Points on +Consider an ellipsoid of revolution with equatorial radius :math:`a`, polar +semi-axis :math:`b`, and flattening :math:`f=(a-b)/a`. Points on the surface of the ellipsoid are characterized by their latitude :math:`\phi` and longitude :math:`\lambda`. (Note that latitude here means the *geographical latitude*, the angle between the normal to the ellipsoid -- cgit v1.2.3 From 410a515228166399f8c145568f20a7799a450757 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sun, 22 Apr 2018 21:55:44 +1200 Subject: Fix subtle typo in table syntax --- docs/source/operations/projections/nsper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/source') diff --git a/docs/source/operations/projections/nsper.rst b/docs/source/operations/projections/nsper.rst index 3f46f2b4..d204305b 100644 --- a/docs/source/operations/projections/nsper.rst +++ b/docs/source/operations/projections/nsper.rst @@ -18,7 +18,7 @@ The near-sided perspective projection simulates a view from a height +---------------------+-------------------------------------------------------------+ | `+h` | Height of the view point above the Earth and must be in | | | the same units as the radius of the sphere. Required. | -+---------------------+-------------------------------------------------------------| ++---------------------+-------------------------------------------------------------+ | `+lat_0` | Latitude (in degrees) of the view position. Defaults to 0. | +---------------------+-------------------------------------------------------------+ | `+lon_0` | Longitude (in degrees) of the view position. Defaults to 0. | -- cgit v1.2.3 From 027c865d05ff272efc8e2dd2b5148e03e41275a1 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sun, 22 Apr 2018 22:01:46 +1200 Subject: Use utf8 option for inputenc instead of utf8x According to https://tex.stackexchange.com/q/13067/2951 utf8x should be avoided if possible. Also, define LaTeX for Unicode PRIME character, used in eqc doc pages. --- docs/source/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/source') diff --git a/docs/source/conf.py b/docs/source/conf.py index ae65995c..5af7a129 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -217,6 +217,9 @@ htmlhelp_basename = 'projdoc' preamble = r""" +\ifdefined\DeclareUnicodeCharacter + \DeclareUnicodeCharacter{2032}{$'$}% prime +\fi """ latex_elements = { @@ -228,7 +231,7 @@ latex_elements = { # Additional stuff for the LaTeX preamble. 'preamble': preamble, -'inputenc':'\usepackage[utf8x]{inputenc}' +'inputenc':'\usepackage[utf8]{inputenc}' # Latex figure (float) alignment #'figure_align': 'htbp', -- cgit v1.2.3 From 3f5657583a3415ea87907a511f97fbb6d64bad93 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sun, 22 Apr 2018 22:08:30 +1200 Subject: Conditional content for index section, using only directive Test status and coverage content should be shown for HTML. PDF documentation does not to self-reference itself. --- docs/source/index.rst | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) (limited to 'docs/source') diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ed64c02..a0125166 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,24 +9,27 @@ and latitude coordinates into cartesian coordinates (and vice versa), and it is a C API for software developers to include coordinate transformation in their own software. PROJ is maintained on `GitHub `_. +.. only:: html -============= ================================================================ - Platform Test Status and Coverage -============= ================================================================ -Travis |travis| -AppVeyor |appveyor| -Coverage |coverals| -============= ================================================================ - -.. |travis| image:: https://travis-ci.org/OSGeo/proj.4.svg?branch=master - :target: https://travis-ci.org/OSGeo/proj.4 -.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/584j49uguwoo5evi?svg=true - :target: https://ci.appveyor.com/project/OSGeo/proj-4 -.. |coverals| image:: https://coveralls.io/repos/OSGeo/proj.4/badge.svg?branch=master - :target: https://coveralls.io/r/OSGeo/proj.4?branch=master - -Full documentation is available as a single PDF at -https://raw.githubusercontent.com/OSGeo/proj.4/gh-pages/proj.pdf + ============= ================================================================ + Platform Test Status and Coverage + ============= ================================================================ + Travis |travis| + AppVeyor |appveyor| + Coverage |coverals| + ============= ================================================================ + + .. |travis| image:: https://travis-ci.org/OSGeo/proj.4.svg?branch=master + :target: https://travis-ci.org/OSGeo/proj.4 + .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/584j49uguwoo5evi?svg=true + :target: https://ci.appveyor.com/project/OSGeo/proj-4 + .. |coverals| image:: https://coveralls.io/repos/OSGeo/proj.4/badge.svg?branch=master + :target: https://coveralls.io/r/OSGeo/proj.4?branch=master + +.. only:: not latex + + Full documentation is available as a single PDF at + https://raw.githubusercontent.com/OSGeo/proj.4/gh-pages/proj.pdf Documentation ================= -- cgit v1.2.3 From 8bcf78e471d0a7dbc5ea7387d33301188ae17de8 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sun, 22 Apr 2018 22:24:20 +1200 Subject: Change title and author to reflect CITATION --- docs/source/conf.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/source') diff --git a/docs/source/conf.py b/docs/source/conf.py index 5af7a129..2c0f480b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -49,9 +49,10 @@ master_doc = 'index' # General information about the project. project = u'PROJ' +title = 'PROJ coordinate transformation software library' +author = 'PROJ contributors' now = datetime.datetime.now() copyright = u'1983-{0}'.format(now.year) -author = u'Gerald Evenden, Frank Warmerdam, and others' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -241,8 +242,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'proj.tex', u'PROJ Documentation', - u'Gerald Evenden', 'manual'), + (master_doc, 'proj.tex', title, author, 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -318,8 +318,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'proj', u'PROJ Documentation', - author, 'proj', 'One line description of project.', + (master_doc, 'proj', title, author, 'proj', + 'Cartographic projections software library.', 'Miscellaneous'), ] -- cgit v1.2.3 From 80c5e198ed05ec26332501c36ee5150655545cdd Mon Sep 17 00:00:00 2001 From: mwtoews Date: Mon, 23 Apr 2018 20:29:04 +1200 Subject: Restore project as PROJ.4 No distinction is required between version and release. Disable default highlight_language (was effectively Python) --- docs/source/conf.py | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) (limited to 'docs/source') diff --git a/docs/source/conf.py b/docs/source/conf.py index 2c0f480b..375b6b5a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,20 +48,24 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'PROJ' + +# Keep legacy project name +project = 'PROJ.4' + +# See CITATION file title = 'PROJ coordinate transformation software library' author = 'PROJ contributors' + now = datetime.datetime.now() copyright = u'1983-{0}'.format(now.year) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. -# -# The short X.Y version. -version = u'5.0.1' -# The full version, including alpha/beta/rc tags. -release = u'5.0.0' +version = '5.0.1' + +# use same |release| as |version| +release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -98,6 +102,9 @@ exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' +# Specify default language for syntax highlighting. +highlight_language = 'none' + # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] -- cgit v1.2.3