Commit Graph

37 Commits

Author SHA1 Message Date
Mike Bayer 9ad0e9a842 hypothetical "floaty thing" for navigation, doesn't really work yet 2014-01-25 17:26:07 -05:00
Mike Bayer e269433efd - tutorial updates
- emphasis on not using a custom contructor by default, making sure it's clear that
you *can* use one
- other separation of narrative from special notes using sidebars
2013-11-10 02:55:06 -05:00
Mike Bayer d6ce68727f - The `version_id_generator parameter of Mapper` can now be specified
to rely upon server generated version identifiers, using triggers
or other database-provided versioning features, by passing the value
``False``.  The ORM will use RETURNING when available to immediately
load the new version identifier, else it will emit a second SELECT.
[ticket:2793]
- The ``eager_defaults`` flag of :class:`.Mapper` will now allow the
newly generated default values to be fetched using an inline
RETURNING clause, rather than a second SELECT statement, for backends
that support RETURNING.
- Added a new variant to :meth:`.ValuesBase.returning` called
:meth:`.ValuesBase.return_defaults`; this allows arbitrary columns
to be added to the RETURNING clause of the statement without interfering
with the compilers usual "implicit returning" feature, which is used to
efficiently fetch newly generated primary key values.  For supporting
backends, a dictionary of all fetched values is present at
:attr:`.ResultProxy.returned_defaults`.
- add a glossary entry for RETURNING
- add documentation for version id generation, [ticket:867]
2013-08-25 14:03:54 -04:00
Mike Bayer 4268ea06b3 move FAQ to the docs, [ticket:2133] 2013-08-21 18:48:34 -04:00
Mike Bayer 5b8e8598ab too small! 2013-08-18 21:29:49 -04:00
Mike Bayer baf6d9214e add some height 2013-08-18 20:49:07 -04:00
Mike Bayer 0abd571f6e CSS tweaks to support version styling in the latest versions of sphinx 2013-07-12 12:14:33 -04:00
Mike Bayer 02a81707dc - create a new system where we can decorate an event method
with @_legacy_signature, will inspect incoming listener functions
to see if they match an older signature, will wrap into a newer sig
- add an event listen argument named=True, will send all args as
kw args so that event listeners can be written with **kw, any combination
of names
- add a doc system to events that writes out the various calling styles
for a given event, produces deprecation messages automatically.
a little concerned that it's a bit verbose but will look at it up
on RTD for awhile to get a feel.
- change the calling signature for bulk update/delete events - we have
the BulkUD object right there, and there's at least six or seven things
people might want to see, so just send the whole BulkUD in
[ticket:2775]
2013-07-08 13:39:56 -04:00
Mike Bayer 5f73cf9c51 glossary updates 2012-10-28 12:27:32 -04:00
Mike Bayer 67f8e6a7fa add changelogs 2012-10-25 15:20:36 -04:00
Mike Bayer bd8ccf436c - add md5-hashed links to changelog entries 2012-10-21 18:36:17 -04:00
Mike Bayer 017989ce8b - move out maxdb
- begin consolidating docs for dialects to be more self contained
- add a separate section for "external" dialects
- not sure how we're going to go with this yet.
2012-10-18 18:24:15 -04:00
Mike Bayer 0c3e2b49b9 - add a glossary b.c. hey its a good idea 2012-09-30 11:54:40 -04:00
Mike Bayer b96250d006 - add new sphinx handlers to render method and attribute inheritance
for inherited members
2012-09-09 14:39:05 -04:00
Mike Bayer 97e97324d6 Add some basic CSS styles for version informations paragraph markups. 2012-06-08 15:55:02 -04:00
Mike Bayer 4b0d4a12c7 integrate new readthedocs/sqla.org doc build 2012-01-23 16:24:24 -05:00
Mike Bayer 6733a9bbdd doc styling rework 2011-11-25 16:17:16 -05:00
Mike Bayer e548b7f8ff - Repaired edge case where mapper would fail
to fully update internal state when a relationship
on a new mapper would establish a backref on the
first mapper.
- continuing with tutorial, moving eager loading into its
own place and describing more fully
2011-08-06 19:30:34 -04:00
Mike Bayer 4abcc0da83 - rework tutorial to be all declarative, all the time
- add detail to declarative docs about base classes
2011-08-06 18:29:37 -04:00
Mike Bayer ba299476b8 - get all comparison operators to document with sphinx - column based, relationship based.
Should fix misunderstandings like [ticket:2177]
2011-05-26 13:30:26 -04:00
Mike Bayer 214efa53a0 css fix 2011-04-17 21:33:44 -04:00
Mike Bayer 33e906638a some font changes to match the site style 2011-04-15 20:41:13 -04:00
Mike Bayer 3f06806cff - add a new "documentation overview" page. rip off a project widely known
to start with "Dj".
2011-04-14 20:50:52 -04:00
Mike Bayer 350aed3fdb - whitespace removal bonanza 2011-01-02 14:23:42 -05:00
Mike Bayer a48ee1b397 - add doc pages for exceptions 2010-09-09 09:24:55 -04:00
Mike Bayer 331141d936 get slightly better about deprecations in docstrings, tho this is kind of an uphill climb 2010-08-09 20:32:37 -04:00
Mike Bayer c71513ce42 introductions 2010-08-08 13:57:18 -04:00
Mike Bayer ce9ba7fdd3 - more 78 chars
- BIGINT doc
- clean up docs in schema.py
2010-07-10 11:47:30 -04:00
Mike Bayer 145a3c627c some prep for the 'viewcode' plugin, which works, though not sure if its helpful 2010-07-04 18:52:34 -04:00
Mike Bayer 7378611832 - added documentation for Inspector [ticket:1820]
- fixed "toplevel" regexp to include tokens of the form foo-bar-toplevel (i.e. multiple dashes)
- some CSS adjustment so that all API headings are in gray.
2010-06-13 15:49:27 -04:00
Mike Bayer 8f11ca9a6a documentation updates 2010-03-28 11:20:22 -04:00
Mike Bayer 3cd2c4661f - 0.6beta3 version
- remove redundant orderinglist docs, use just module docs
- add warning for primary keys/unique colummns, [ticket:1669]
2010-03-27 15:20:03 -04:00
Mike Bayer dfbb1fc148 a big, unmissable, green box describing the caveats of String() and Sequence. 2010-02-05 01:01:40 +00:00
Mike Bayer 2acd40f0dc tweaks 2009-09-20 16:48:15 +00:00
Mike Bayer 6d4186999f a picture 2009-09-20 16:40:02 +00:00
Mike Bayer dd91a165cc - restored the main search form
- fixed search highlighting
- the url docstring works again from a ReST perspective, still not PDF
2008-12-08 00:20:20 +00:00
Mike Bayer 1c329624a5 - merged -r5338:5429 of sphinx branch.
- Documentation has been converted to Sphinx.
In particular, the generated API documentation
has been constructed into a full blown
"API Reference" section which organizes
editorial documentation combined with
generated docstrings.   Cross linking between
sections and API docs are vastly improved,
a javascript-powered search feature is
provided, and a full index of all
classes, functions and members is provided.
2008-12-06 16:59:48 +00:00