diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2018-04-25 10:31:38 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-25 10:31:38 +0200 |
| commit | 7b71bf72a2daa3074c80b5f49155ec492aeaca89 (patch) | |
| tree | 04fbd613b12f049b5342c3dff3c44ae22149ac6e /docs/source | |
| parent | 93db7b7b16f8904e23a7516079708ec82977fad3 (diff) | |
| parent | 80c5e198ed05ec26332501c36ee5150655545cdd (diff) | |
| download | PROJ-7b71bf72a2daa3074c80b5f49155ec492aeaca89.tar.gz PROJ-7b71bf72a2daa3074c80b5f49155ec492aeaca89.zip | |
Merge pull request #945 from mwtoews/doc-update
Update documentation title, author, and other details
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/conf.py | 38 | ||||
| -rw-r--r-- | docs/source/geodesic.rst | 4 | ||||
| -rw-r--r-- | docs/source/index.rst | 37 | ||||
| -rw-r--r-- | docs/source/operations/projections/nsper.rst | 2 |
4 files changed, 47 insertions, 34 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index fa1de3ed..375b6b5a 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,19 +48,24 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'PROJ.4' + +# 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) -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 # 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. @@ -97,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 = [] @@ -211,12 +219,15 @@ 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 --------------------------------------------- preamble = r""" +\ifdefined\DeclareUnicodeCharacter + \DeclareUnicodeCharacter{2032}{$'$}% prime +\fi """ latex_elements = { @@ -228,7 +239,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', @@ -238,8 +249,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', - 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 @@ -315,8 +325,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', title, author, 'proj', + 'Cartographic projections software library.', 'Miscellaneous'), ] 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 diff --git a/docs/source/index.rst b/docs/source/index.rst index 3f02de3b..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 <http://github.com/OSGeo/proj.4/>`_. +.. 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/proj4.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 ================= 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. | |
