aboutsummaryrefslogtreecommitdiff
path: root/docs/source/conf.py
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-04-30 11:05:14 +0200
committerKristian Evers <kristianevers@gmail.com>2018-04-30 11:05:14 +0200
commitcd23e5f1b2630ee07567bd361373ba725774061b (patch)
treeb33a6e3ad9619a1e9870cfddc316a9bb91e2a36c /docs/source/conf.py
parentf8aacfb513c9380c4df3b2dda124c0b1da7aaa3c (diff)
parentd0fefa4104d9b655d59e400cda616f0b4d407071 (diff)
downloadPROJ-cd23e5f1b2630ee07567bd361373ba725774061b.tar.gz
PROJ-cd23e5f1b2630ee07567bd361373ba725774061b.zip
Merge remote-tracking branch 'osgeo/master' into doc-improvements
Diffstat (limited to 'docs/source/conf.py')
-rw-r--r--docs/source/conf.py38
1 files changed, 24 insertions, 14 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 3a93fb81..b57e0f36 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.0'
-# 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', False),
+ (master_doc, 'proj.tex', title, author, 'manual'),
]
latex_toplevel_sectioning = 'chapter'
@@ -317,8 +327,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'),
]