Changeset 708 for branches/4.x


Ignore:
Timestamp:
Jan 10, 2016, 3:59:01 PM (4 years ago)
Author:
cito
Message:

Move tutorial into a chapter of the docs

Converted the tutorial files from Python scripts to Sphinx docs
and made them a chapter of the overall documentation.
Some of the examples were pretty outdated and did not even run any more on
the PostgreSQL versions supported by PyGreSQL; these have been modernized.
Also added some explanations of some of the classic PyGreSQL methods.

Location:
branches/4.x
Files:
6 added
1 deleted
14 edited

Legend:

Unmodified
Added
Removed
  • branches/4.x/docs/contents/changelog.rst

    r701 r708  
    1313- Fix notification handler (Thanks Patrick TJ McPhee).
    1414- Fix a small issue with large objects.
     15- The tutorial files have become a chapter in the documentation.
    1516- Greatly improve unit testing, tests run with Python 2.4 to 2.7 again.
    1617
  • branches/4.x/docs/contents/general.rst

    r695 r708  
    1 General PyGreSQL programming information
     1General PyGreSQL Programming Information
    22----------------------------------------
    33
  • branches/4.x/docs/contents/index.rst

    r696 r708  
    99
    1010    Installing PyGreSQL <install>
    11     What's new and history of changes <changelog>
    12     General PyGreSQL programming information <general>
     11    What's New and History of Changes <changelog>
     12    General PyGreSQL Programming Information <general>
    1313    The Classic PyGreSQL Interface <pg/index>
    1414    The DB-API Compliant Interface <pgdb/index>
     15    A PostgreSQL Primer <postgres/index>
    1516    Examples for using PyGreSQL <examples>
    1617
  • branches/4.x/docs/contents/pg/connection.rst

    r707 r708  
    11pgobject -- The connection object
    22=================================
     3
     4.. py:currentmodule:: pg
    35
    46.. class:: pgobject
  • branches/4.x/docs/contents/pg/db_wrapper.rst

    r707 r708  
    11The DB wrapper class
    22====================
     3
     4.. py:currentmodule:: pg
    35
    46.. class:: DB
  • branches/4.x/docs/contents/pg/large_objects.rst

    r695 r708  
    11pglarge -- Large Objects
    22========================
     3
     4.. py:currentmodule:: pg
    35
    46.. class:: pglarge
  • branches/4.x/docs/contents/pg/module.rst

    r707 r708  
    11Module functions and constants
    22==============================
     3
     4.. py:currentmodule:: pg
    35
    46The :mod:`pg` module defines a few functions that allow to connect
     
    1921---------------------------------------
    2022
    21 .. function:: pg.connect([dbname], [host], [port], [opt], [tty], [user], [passwd])
     23.. function:: connect([dbname], [host], [port], [opt], [tty], [user], [passwd])
    2224
    2325    Open a :mod:`pg` connection
  • branches/4.x/docs/contents/pg/query.rst

    r707 r708  
    11pgqueryobject methods
    22=====================
     3
     4.. py:currentmodule:: pg
    35
    46.. class:: pgqueryobject
  • branches/4.x/docs/contents/pgdb/connection.rst

    r695 r708  
    11pgdbCnx -- The connection object
    22================================
     3
     4.. py:currentmodule:: pgdb
    35
    46.. class:: pgdbCnx
  • branches/4.x/docs/contents/pgdb/cursor.rst

    r707 r708  
    11pgdbCursor -- The cursor object
    22===============================
     3
     4.. py:currentmodule:: pgdb
    35
    46.. class:: pgdbCursor
  • branches/4.x/docs/contents/pgdb/module.rst

    r695 r708  
    11Module functions and constants
    22==============================
     3
     4.. py:currentmodule:: pgdb
    35
    46The :mod:`pgdb` module defines a :func:`connect` function that allows to
     
    911---------------------------------------
    1012
    11 .. function:: pgdb.connect([dsn], [user], [password], [host], [database])
     13.. function:: connect([dsn], [user], [password], [host], [database])
    1214
    1315    Return a new connection to the database
  • branches/4.x/docs/contents/pgdb/types.rst

    r696 r708  
    11pgdbType -- Type objects and constructors
    22=========================================
     3
     4.. py:currentmodule:: pgdb
    35
    46.. class:: pgdbType
  • branches/4.x/docs/download/files.rst

    r695 r708  
    2525tests/     a suite of unit tests for PyGreSQL
    2626
    27 tutorial/  demos directory
    28 
    29            The samples contained in this directory have been taken
    30            from the PostgreSQL manual and were used for module testing.
    31            They demonstrate some PostgreSQL features.
    32 
    3327========== =
  • branches/4.x/mktar

    r695 r708  
    4141HTMLFILES="docs/_build/html"
    4242TESTFILES="module/tests/*.py"
    43 TUTFILES="tutorial/*.py"
    4443
    4544echo "Making source tarball..."
     
    5150mkdir -p $TD/docs/_build/html
    5251mkdir $TD/tests
    53 mkdir $TD/tutorial
    5452cp $MODFILES $TD
    5553cp -r $DOCFILES $TD/docs
    5654cp -r $HTMLFILES $TD/docs/_build
    5755cp $TESTFILES $TD/tests
    58 cp $TUTFILES $TD/tutorial
    5956tar -cvzf $TF $TD
    6057chmod 644 $TF
     
    6461
    6562echo "$TF has been built"
    66 
Note: See TracChangeset for help on using the changeset viewer.