Commit Graph

31 Commits

Author SHA1 Message Date
Mike Bayer a1aed312fc comment out PDF for now, it sucks 2012-11-18 12:36:24 -05:00
Mike Bayer 94323a7760 - add a missing reference handler to handle the inheriting names that aren't in the docs 2012-10-28 18:21:53 -04:00
Mike Bayer 67f8e6a7fa add changelogs 2012-10-25 15:20:36 -04:00
Mike Bayer 08a3d1c81c - support multiple top-level cats in a changeset
- include ticket in the md5
2012-10-22 13:41:56 -04:00
Mike Bayer bd8ccf436c - add md5-hashed links to changelog entries 2012-10-21 18:36:17 -04:00
Mike Bayer e5fb4fec47 add support to link to changelogs and pullrequests 2012-10-21 17:26:10 -04:00
Mike Bayer f2bc0ddcb4 updated changelog thing 2012-10-20 21:24:00 -04:00
Mike Bayer ccd5d7564e - genericize the changelog plugin a bit, lets see if it works in other projects 2012-10-20 20:41:44 -04:00
Mike Bayer 690f484f5c - move all CHANGES files into the sphinx docs. this is rudimental now
but puts the changelog in a more data driven format, so that we
can begin linking version directives with them as well
as with migration documents, once those are also moved into sphinx.
2012-10-20 18:28:02 -04:00
Mike Bayer e02bcfb127 - clarify what the link is 2012-10-19 19:37:48 -04:00
Mike Bayer 675558bffb - rework the sphinx customizations into distinct modules
- build a new Sphinx extension that allows dialect info
to be entered as directives which is then rendered consistently
throughout all dialect/dbapi sections
- break out the "empty_strings" requirement for oracle test
2012-10-19 19:20:18 -04:00
Mike Bayer 43b8346b3c - rework scoped_session and sessionmaker, [ticket:2500]
- rewrite tons of session docs
2012-09-10 20:40:42 -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 22ba1c43b7 -whitespace bonanza, contd 2012-07-28 17:05:50 -04:00
Mike Bayer 4b0d4a12c7 integrate new readthedocs/sqla.org doc build 2012-01-23 16:24:24 -05:00
Mike Bayer 737456866c add a "jinja2 fallback" renderer for render_string(), which is used for the js/css templates
we don't really care about.  not sure if this is going to break again with a newer sphinx
or what, but fixes [ticket:2359] for now.
2011-12-30 15:29:44 -05:00
Mike Bayer 46e92b478a long line formatting 2011-08-07 18:05:49 -04:00
Mike Bayer c0ffa33b2f - fix documentation versions in conf.py, other changes to site layout 2011-07-01 22:38:11 -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 fcded554df - rework setup.py script to work with:
- Python 3
   - Python 3 builds if Distribute isn't installed
- rework install documentation again
- raise if doc build with mako < 0.4.1
- Python 3.1 builds force doctest parse but then fails due to distribute bug,
  so remove usage of backslash \\ in hybrid.py docstring
- put in the latest ez_setup.py
2011-04-17 13:22:33 -04:00
Mike Bayer 2136054ca8 - some doc reorg
- change engine.Connection to _connection_cls so sphinx doesn't get upset
- globally add "." to all :class:`Foo`
- start naming sections that are mostly docstrings "API Documentation - blah blah"
- move some ad-hoc docstrings into "API" sections, there is some inconsistency here
and it may be that we just have to leave it that way
- add "internals" rsts to core, orm, I'm not super thrilled how these look but they are
targeted by some of the public api docs, users typically become aware of these anyway
2011-03-17 21:13:14 -04:00
Mike Bayer 350aed3fdb - whitespace removal bonanza 2011-01-02 14:23:42 -05:00
Mike Bayer 6b911a5267 for internal link to top render # 2010-09-26 12:55:51 -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 145e3bc584 - tweak to work with sphinx 1.0b2
- more open ended language for bound metadata
2010-06-08 15:53:13 -04:00
Mike Bayer d6edf5557f revert the newline workaround, fix the regexp that was consuming 2010-03-20 13:41:18 -04:00
Mike Bayer 5ca7fa3abd all about DDL events 2009-09-11 22:37:13 +00:00
Mike Bayer 4928ea0e46 - updated builders for latest sphinx tip
- applied patch from [ticket:1321]
2009-03-02 00:01:09 +00:00
Mike Bayer 172781e678 - added sphinx handler to allow __init__ methods through
- sqlite module documentation
- some corrections to pool docs
- the example in URL.translate_connect_args() never made any sense anyway so removed it
2008-12-17 20:12:07 +00:00
Mike Bayer 480436ff7c - moved index.rst around to have the API docs right there, no "Main Documentation" chapter which is fairly needless. this all allows PDF to have a decent TOC on the side with only two levels (can we change that ?)
- added LatexFormatter.
- PDF wont work until issue with the docstirng in url.py/URL.translate_connect_args is fixed.
2008-12-07 23:58:02 +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