Changeset 710 for trunk/docs


Ignore:
Timestamp:
Jan 10, 2016, 5:20:39 PM (4 years ago)
Author:
cito
Message:

Port all doc changes from 4.x branch to trunk

Location:
trunk/docs
Files:
38 added
9 deleted
3 edited
4 moved

Legend:

Unmodified
Added
Removed
  • trunk/docs/conf.py

    r674 r710  
    1616import shlex
    1717
    18 # import Cloud
    19 import cloud_sptheme as csp
     18# import Cloud theme
     19# this will also automatically add the theme directory
     20import cloud_sptheme
    2021
    2122# If extensions (or modules to document with autodoc) are in another directory,
     
    5051project = 'PyGreSQL'
    5152author = 'The PyGreSQL team'
    52 copyright = '2015, ' + author
     53copyright = '2016, ' + author
    5354
    5455# The version info for the project you're documenting, acts as replacement for
     
    7778exclude_patterns = ['_build']
    7879
     80# List of pages which are included in other pages and therefore should
     81# not appear in the toctree.
     82exclude_patterns += ['about.rst',
     83    'download/download.rst', 'download/files.rst',
     84    'community/mailinglist.rst', 'community/source.rst',
     85    'community/bugtracker.rst', 'community/support.rst',
     86    'community/homes.rst']
     87
    7988# The reST default role (used for this markup: `text`) for all documents.
    8089#default_role = None
     
    117126
    118127# Add any paths that contain custom themes here, relative to this directory.
    119 html_theme_path = [csp.get_theme_dir()]
     128html_theme_path = ['_themes']
    120129
    121130# The name for this set of Sphinx documents.  If None, it defaults to
     
    133142# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    134143# pixels large.
    135 #html_favicon = None
     144html_favicon = '_static/favicon.ico'
    136145
    137146# Add any paths that contain custom static files (such as style sheets) here,
  • trunk/docs/contents/changelog.rst

    r709 r710  
    66- This version runs on both Python 2 and Python 3.
    77- The supported versions are Python 2.6 to 2.7, and 3.3 to 3.5.
    8 - PostgreSQL is supported in all versions from 9.0 to 9.4.
     8- PostgreSQL is supported in all versions from 9.0 to 9.5.
    99- The DB-API 2 module now always returns result rows as named tuples
    1010  instead of simply lists as before. The documentation explains how
     
    2424- The 7-tuples returned by the description attribute of a pgdb cursor
    2525  are now named tuples, i.e. their elements can be also accessed by name.
     26  The column names and types can now also be requested through the
     27  colnames and coltypes attributes, which are not part of DB-API 2 though.
    2628- The tty parameter and attribute of database connections has been
    2729  removed since it is not supported any more since PostgreSQL 7.4.
     
    3133- Set a better default for the user option "escaping-funcs".
    3234- The supported Python versions are 2.4 to 2.7.
    33 - PostgreSQL is supported in all versions from 8.3 to 9.4.
     35- PostgreSQL is supported in all versions from 8.3 to 9.5.
    3436- Force build to compile with no errors.
    3537- Fix decimal point handling.
    3638- Add option to return boolean values as bool objects.
    3739- Add option to return money values as string.
     40- get_tables() does not list information schema tables any more.
    3841- Fix notification handler (Thanks Patrick TJ McPhee).
    3942- Fix a small issue with large objects.
     43- The tutorial files have become a chapter in the documentation.
    4044- Greatly improve unit testing, tests run with Python 2.4 to 2.7 again.
    4145
  • trunk/docs/contents/examples.rst

    r709 r710  
    55So far I only have a few but if you have an example for me, you can
    66either send me the files or the URL for me to point to.
     7
     8The :doc:`postgres/index` that is part of the PyGreSQL distribution
     9shows some examples of using PostgreSQL with PyGreSQL.
    710
    811Here is a
  • trunk/docs/contents/install.rst

    r709 r710  
    1212
    1313The current version of PyGreSQL has been tested with Python versions
    14 2.6, 2.7, 3.3, 3.4, 3.5 and PostGreSQL version 9.0 to 9.4.
     142.6, 2.7, 3.3, 3.4, 3.5 and PostGreSQL version 9.0 to 9.5.
    1515
    1616PyGreSQL will be installed as three modules, a dynamic module called
  • trunk/docs/copyright.rst

    r674 r710  
    1111(darcy@PyGreSQL.org)
    1212
    13 Further modifications copyright (c) 2009-2012 by the PyGreSQL team.
     13Further modifications copyright (c) 2009-2016 by the PyGreSQL team.
    1414
    1515Permission to use, copy, modify, and distribute this software and its
     
    3030AUTHORS HAVE NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
    3131ENHANCEMENTS, OR MODIFICATIONS.
    32 
    33 
  • trunk/docs/index.rst

    r674 r710  
    1 .. PyGreSQL documentation master file, created by
    2    sphinx-quickstart on Thu Nov  1 07:47:06 2012.
    3    You can adapt this file completely to your liking, but it should at least
    4    contain the root `toctree` directive.
     1.. PyGreSQL documentation master file
    52
    6 PyGreSQL - PostgreSQL module for Python
    7 =======================================
    8 
    9 Contents:
     3Welcome to PyGreSQL
     4===================
    105
    116.. toctree::
    12    :maxdepth: 1
     7    :hidden:
    138
    14    introduction
    15    copyright
    16    changelog
    17    install
    18    interface
    19    pg
    20    pgdb
    21    source
    22    mailinglist
    23    future
    24    examples
     9    copyright
     10    announce
     11    download/index
     12    contents/index
     13    community/index
    2514
    26 Indices and tables
    27 ==================
    28 
    29 * :ref:`genindex`
    30 * :ref:`modindex`
    31 * :ref:`search`
     15.. include:: about.rst
Note: See TracChangeset for help on using the changeset viewer.