Ignore:
Timestamp:
Dec 29, 2015, 3:02:11 PM (4 years ago)
Author:
cito
Message:

Update Sphinx conf and make files

Update the conf and make files for creating the documentation
so that newer Sphinx features are supported.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/4.x/docs/conf.py

    r661 r669  
    11# -*- coding: utf-8 -*-
    22#
    3 # PyGreSQL documentation build configuration file, created by
    4 # sphinx-quickstart on Thu Nov  1 07:47:06 2012.
    5 #
    6 # This file is execfile()d with the current directory set to its containing dir.
     3# PyGreSQL documentation build configuration file.
     4#
     5# This file is execfile()d with the current directory set to its
     6# containing dir.
    77#
    88# Note that not all possible configuration values are present in this
     
    1212# serve to show the default.
    1313
    14 import sys, os
     14import sys
     15import os
     16import shlex
    1517
    1618# import Cloud
     
    2224#sys.path.insert(0, os.path.abspath('.'))
    2325
    24 # -- General configuration -----------------------------------------------------
     26# -- General configuration ------------------------------------------------
    2527
    2628# If your documentation needs a minimal Sphinx version, state it here.
    2729#needs_sphinx = '1.0'
    2830
    29 # Add any Sphinx extension module names here, as strings. They can be extensions
    30 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
     31# Add any Sphinx extension module names here, as strings. They can be
     32# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
    3133extensions = ['sphinx.ext.autodoc']
    3234
     
    3436templates_path = ['_templates']
    3537
    36 # The suffix of source filenames.
    37 source_suffix = '.rst'
     38# The suffix(es) of source filenames.
     39# You can specify multiple suffix as a list of string:
     40# source_suffix = ['.rst', '.md']
     41source_suffix = '.txt'
    3842
    3943# The encoding of source files.
     
    4549# General information about the project.
    4650project = u'PyGreSQL'
    47 copyright = u'2015, The PyGreSQL team'
     51author = u'The PyGreSQL Team'
     52copyright = u'2015, ' + author
    4853
    4954# The version info for the project you're documenting, acts as replacement for
     
    5257#
    5358# The short X.Y version.
    54 version = '4.2'
     59version = u'4.2'
    5560# The full version, including alpha/beta/rc tags.
    56 release = '4.2'
     61release = u'4.2'
    5762
    5863# The language for content autogenerated by Sphinx. Refer to documentation
    5964# for a list of supported languages.
    60 #language = None
     65# This is also used if you do content translation via gettext catalogs.
     66# Usually you set "language" from the command line for these cases.
     67language = None
    6168
    6269# There are two options for replacing |today|: either, you set today to some
     
    7077exclude_patterns = ['_build']
    7178
    72 # The reST default role (used for this markup: `text`) to use for all documents.
     79# The reST default role (used for this markup: `text`) for all documents.
    7380#default_role = None
    7481
     
    9097#modindex_common_prefix = []
    9198
    92 
    93 # -- Options for HTML output ---------------------------------------------------
     99# If true, keep warnings as "system message" paragraphs in the built documents.
     100#keep_warnings = False
     101
     102# If true, `todo` and `todoList` produce output, else they produce nothing.
     103todo_include_todos = False
     104
     105
     106# -- Options for HTML output ----------------------------------------------
    94107
    95108# The theme to use for HTML and HTML Help pages.  See the documentation for
     
    100113# further.  For a list of options available for each theme, see the
    101114# documentation.
    102 html_theme_options = { "defaultcollapsed": True, }
     115html_theme_options = {'defaultcollapsed': True}
    103116
    104117# Add any paths that contain custom themes here, relative to this directory.
     
    126139html_static_path = ['_static']
    127140
     141# Add any extra paths that contain custom files (such as robots.txt or
     142# .htaccess) here, relative to this directory. These files are copied
     143# directly to the root of the documentation.
     144#html_extra_path = []
     145
    128146# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    129147# using the given strftime format.
     
    167185#html_file_suffix = None
    168186
     187# Language to be used for generating the HTML full-text search index.
     188# Sphinx supports the following languages:
     189#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
     190#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
     191#html_search_language = 'en'
     192
     193# A dictionary with options for the search language support, empty by default.
     194# Now only 'ja' uses this config value
     195#html_search_options = {'type': 'default'}
     196
     197# The name of a javascript file (relative to the configuration directory) that
     198# implements a search results scorer. If empty, the default will be used.
     199#html_search_scorer = 'scorer.js'
     200
    169201# Output file base name for HTML help builder.
    170202htmlhelp_basename = 'PyGreSQLdoc'
    171203
    172204
    173 # -- Options for LaTeX output --------------------------------------------------
     205# -- Options for LaTeX output ---------------------------------------------
    174206
    175207latex_elements = {
     
    182214# Additional stuff for the LaTeX preamble.
    183215#'preamble': '',
     216
     217# Latex figure (float) alignment
     218#'figure_align': 'htbp',
    184219}
    185220
    186221# Grouping the document tree into LaTeX files. List of tuples
    187 # (source start file, target name, title, author, documentclass [howto/manual]).
     222# (source start file, target name, title,
     223#  author, documentclass [howto, manual, or own class]).
    188224latex_documents = [
    189   ('index', 'PyGreSQL.tex', u'PyGreSQL Documentation',
    190    u'The PyGreSQL team', 'manual'),
     225    (master_doc, 'PyGreSQL.tex', u'PyGreSQL Documentation',
     226     author, 'manual'),
    191227]
    192228
     
    212248
    213249
    214 # -- Options for manual page output --------------------------------------------
     250# -- Options for manual page output ---------------------------------------
    215251
    216252# One entry per manual page. List of tuples
    217253# (source start file, name, description, authors, manual section).
    218254man_pages = [
    219     ('index', 'pygresql', u'PyGreSQL Documentation',
    220      [u'The PyGreSQL team'], 1)
     255    (master_doc, 'pygresql', u'PyGreSQL Documentation', [author], 1)
    221256]
    222257
     
    225260
    226261
    227 # -- Options for Texinfo output ------------------------------------------------
     262# -- Options for Texinfo output -------------------------------------------
    228263
    229264# Grouping the document tree into Texinfo files. List of tuples
     
    231266#  dir menu entry, description, category)
    232267texinfo_documents = [
    233   ('index', 'PyGreSQL', u'PyGreSQL Documentation',
    234    u'The PyGreSQL team', 'PyGreSQL', 'One line description of project.',
    235    'Miscellaneous'),
     268    (master_doc, 'PyGreSQL', u'PyGreSQL Documentation',
     269     author, 'PyGreSQL', 'One line description of project.',
     270     'Miscellaneous'),
    236271]
    237272
     
    244279# How to display URL addresses: 'footnote', 'no', or 'inline'.
    245280#texinfo_show_urls = 'footnote'
     281
     282# If true, do not generate a @detailmenu in the "Top" node's menu.
     283#texinfo_no_detailmenu = False
Note: See TracChangeset for help on using the changeset viewer.