Browse Source

Beefed up latex output. Unfortunately parts look ugly.

pull/1638/head
Armin Ronacher 15 years ago
parent
commit
cbcd15c3b5
  1. 1
      docs/conf.py
  2. 42
      docs/contents.rst.inc
  3. 2
      docs/errorhandling.rst
  4. 9
      docs/flaskstyle.sty
  5. 45
      docs/index.rst
  6. 36
      docs/latexindex.rst
  7. 7
      flask.py

1
docs/conf.py

@ -190,6 +190,7 @@ latex_elements = {
'pointsize': '12pt', 'pointsize': '12pt',
'preamble': r'\usepackage{flaskstyle}' 'preamble': r'\usepackage{flaskstyle}'
} }
latex_use_parts = True
latex_additional_files = ['flaskstyle.sty', 'logo.pdf'] latex_additional_files = ['flaskstyle.sty', 'logo.pdf']

42
docs/contents.rst.inc

@ -1,42 +0,0 @@
User's Guide
------------
This part of the documentation is written text and should give you an idea
how to work with Flask. It's a series of step-by-step instructions for
web development.
.. toctree::
:maxdepth: 2
foreword
installation
quickstart
tutorial/index
testing
errorhandling
patterns/index
deploying/index
becomingbig
API Reference
-------------
If you are looking for information on a specific function, class or
method, this part of the documentation is for you:
.. toctree::
:maxdepth: 2
api
Additional Notes
----------------
Design notes, legal information and changelog are here for the interested:
.. toctree::
:maxdepth: 2
design
license
changelog

2
docs/errorhandling.rst

@ -163,6 +163,8 @@ Here is a list of useful formatting variables for the format string. Note
that this list is not complete, consult the official documentation of the that this list is not complete, consult the official documentation of the
:mod:`logging` package for a full list. :mod:`logging` package for a full list.
.. tabularcolumns:: |p{3cm}|p{12cm}|
+------------------+----------------------------------------------------+ +------------------+----------------------------------------------------+
| Format | Description | | Format | Description |
+==================+====================================================+ +==================+====================================================+

9
docs/flaskstyle.sty

@ -70,4 +70,13 @@
\ChNumVar{\raggedleft \bfseries\Large} \ChNumVar{\raggedleft \bfseries\Large}
\ChTitleVar{\raggedleft \rm\Huge} \ChTitleVar{\raggedleft \rm\Huge}
% use inconsolata font
\usepackage{inconsolata} \usepackage{inconsolata}
% fix single quotes, for inconsolata. (does not work)
%%\usepackage{textcomp}
%%\begingroup
%% \catcode`'=\active
%% \g@addto@macro\@noligs{\let'\textsinglequote}
%% \endgroup
%%\endinput

45
docs/index.rst

@ -1,3 +1,5 @@
:orphan:
Welcome to Flask Welcome to Flask
================ ================
@ -25,4 +27,45 @@ following links:
.. _Jinja2: http://jinja.pocoo.org/2/ .. _Jinja2: http://jinja.pocoo.org/2/
.. _Werkzeug: http://werkzeug.pocoo.org/ .. _Werkzeug: http://werkzeug.pocoo.org/
.. include:: contents.rst.inc User's Guide
------------
This part of the documentation is written text and should give you an idea
how to work with Flask. It's a series of step-by-step instructions for
web development.
.. toctree::
:maxdepth: 2
foreword
installation
quickstart
tutorial/index
testing
errorhandling
patterns/index
deploying/index
becomingbig
API Reference
-------------
If you are looking for information on a specific function, class or
method, this part of the documentation is for you:
.. toctree::
:maxdepth: 2
api
Additional Notes
----------------
Design notes, legal information and changelog are here for the interested:
.. toctree::
:maxdepth: 2
design
license
changelog

36
docs/latexindex.rst

@ -1,4 +1,38 @@
:orphan:
Flask Documentation Flask Documentation
=================== ===================
.. include:: contents.rst.inc User's Guide
------------
.. toctree::
:maxdepth: 3
foreword
installation
quickstart
tutorial/index
testing
errorhandling
patterns/index
deploying/index
becomingbig
API Reference
-------------
.. toctree::
:maxdepth: 3
api
Additional Notes
----------------
.. toctree::
:maxdepth: 3
design
license
changelog

7
flask.py

@ -1097,6 +1097,8 @@ class Flask(_PackageBoundObject):
The following types are allowed for `rv`: The following types are allowed for `rv`:
.. tabularcolumns:: |p{3.5cm}|p{9.5cm}|
======================= =========================================== ======================= ===========================================
:attr:`response_class` the object is returned unchanged :attr:`response_class` the object is returned unchanged
:class:`str` a response object is created with the :class:`str` a response object is created with the
@ -1222,3 +1224,8 @@ current_app = LocalProxy(lambda: _request_ctx_stack.top.app)
request = LocalProxy(lambda: _request_ctx_stack.top.request) request = LocalProxy(lambda: _request_ctx_stack.top.request)
session = LocalProxy(lambda: _request_ctx_stack.top.session) session = LocalProxy(lambda: _request_ctx_stack.top.session)
g = LocalProxy(lambda: _request_ctx_stack.top.g) g = LocalProxy(lambda: _request_ctx_stack.top.g)
# script interface to run a development server
if __name__ == '__main__':
sys.exit(main(sys.argv))

Loading…
Cancel
Save