- 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.
This commit is contained in:
Mike Bayer
2008-12-07 23:58:02 +00:00
parent 058c2895be
commit 480436ff7c
4 changed files with 34 additions and 14 deletions
+15 -1
View File
@@ -122,10 +122,24 @@ class PopupSQLFormatter(HtmlFormatter):
for t, v in _strip_trailing_whitespace(HtmlFormatter._format_lines(self, iter(buf))):
yield t, v
class PopupLatexFormatter(LatexFormatter):
def _filter_tokens(self, tokensource):
for ttype, value in apply_filters(tokensource, [StripDocTestFilter()]):
if ttype in Token.Sql:
if ttype is not Token.Sql.Link and ttype is not Token.Sql.Open:
yield Token.Literal, re.sub(r'(?:[{stop}|\n]*)$', '', value)
else:
continue
else:
yield ttype, value
def format(self, tokensource, outfile):
LatexFormatter.format(self, self._filter_tokens(tokensource), outfile)
def setup(app):
app.add_lexer('pycon+sql', PyConWithSQLLexer())
app.add_lexer('python+sql', PythonWithSQLLexer())
PygmentsBridge.html_formatter = PopupSQLFormatter
#PygmentsBridge.latex_formatter = LatexFormatter
PygmentsBridge.latex_formatter = PopupLatexFormatter
+13 -6
View File
@@ -1,11 +1,7 @@
Table of Contents
=================
Main Documentation
------------------
.. toctree::
:glob:
intro
ormtutorial
@@ -14,8 +10,19 @@ Main Documentation
session
dbengine
metadata
reference/index
API Documentation
-----------------
.. toctree::
:glob:
:maxdepth: 3
reference/sqlalchemy/index
reference/orm/index
reference/ext/index
reference/dialects/index
Indices and tables
------------------
+1 -1
View File
@@ -10,7 +10,7 @@ Creating Engines
.. autoclass:: sqlalchemy.engine.url.URL
:members:
Connectables
------------
+5 -6
View File
@@ -102,14 +102,13 @@ class URL(object):
used as the keys by default. Unset or false attributes are omitted
from the final dictionary.
:param \**kw: Optional, alternate key names for url
attributes::
:param \**kw: Optional, alternate key names for url attributes::
# return 'username' as 'user'
username='user'
# return 'username' as 'user'
username='user'
# omit 'database'
database=None
# omit 'database'
database=None
:param names: Deprecated. Same purpose as the keyword-based alternate names,
but correlates the name to the original positionally.