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/Makefile | 8 ++++---- docs/source/conf.py | 12 ++++++------ docs/source/index.rst | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile index 4bd082c8..ec0a2e6e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -94,9 +94,9 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/proj4.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/proj.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/proj4.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/proj.qhc" .PHONY: applehelp applehelp: @@ -113,8 +113,8 @@ devhelp: @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/proj4" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/proj4" + @echo "# mkdir -p $$HOME/.local/share/devhelp/proj" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/proj" @echo "# devhelp" .PHONY: epub 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') 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') 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') 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') 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') 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') 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