Merge branch 'master' into module-support
This commit is contained in:
commit
41de129844
7 changed files with 136 additions and 61 deletions
7
Makefile
7
Makefile
|
|
@ -11,4 +11,9 @@ clean-pyc:
|
||||||
find . -name '*~' -exec rm -f {} +
|
find . -name '*~' -exec rm -f {} +
|
||||||
|
|
||||||
upload-docs:
|
upload-docs:
|
||||||
$(MAKE) -C docs dirhtml && scp -r docs/_build/dirhtml/* pocoo.org:/var/www/flask.pocoo.org/docs/
|
$(MAKE) -C docs html dirhtml latex
|
||||||
|
$(MAKE) -C docs/_build/latex all-pdf
|
||||||
|
cd docs/_build/; mv html flask-docs; zip -r flask-docs.zip flask-docs; mv flask-docs html
|
||||||
|
scp -r docs/_build/dirhtml/* pocoo.org:/var/www/flask.pocoo.org/docs/
|
||||||
|
scp -r docs/_build/latex/Flask.pdf pocoo.org:/var/www/flask.pocoo.org/docs/flask-docs.pdf
|
||||||
|
scp -r docs/_build/flask-docs.zip pocoo.org:/var/www/flask.pocoo.org/docs/
|
||||||
|
|
|
||||||
30
docs/conf.py
30
docs/conf.py
|
|
@ -172,35 +172,27 @@ htmlhelp_basename = 'Flaskdoc'
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
|
|
||||||
# The paper size ('letter' or 'a4').
|
|
||||||
#latex_paper_size = 'letter'
|
|
||||||
|
|
||||||
# The font size ('10pt', '11pt' or '12pt').
|
|
||||||
#latex_font_size = '10pt'
|
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'Flask.tex', u'Flask Documentation',
|
('latexindex', 'Flask.tex', u'Flask Documentation',
|
||||||
u'Armin Ronacher', 'manual'),
|
u'Armin Ronacher', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
|
||||||
# the title page.
|
|
||||||
#latex_logo = None
|
|
||||||
|
|
||||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
|
||||||
# not chapters.
|
|
||||||
#latex_use_parts = False
|
|
||||||
|
|
||||||
# Additional stuff for the LaTeX preamble.
|
|
||||||
#latex_preamble = ''
|
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
# Documents to append as an appendix to all manuals.
|
||||||
#latex_appendices = []
|
#latex_appendices = []
|
||||||
|
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
#latex_use_modindex = True
|
latex_use_modindex = False
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
'fontpkg': r'\usepackage{mathpazo}',
|
||||||
|
'papersize': 'a4paper',
|
||||||
|
'pointsize': '12pt',
|
||||||
|
'preamble': r'\usepackage{flaskstyle}'
|
||||||
|
}
|
||||||
|
|
||||||
|
latex_additional_files = ['flaskstyle.sty', 'logo.pdf']
|
||||||
|
|
||||||
|
|
||||||
# -- Options for Epub output ---------------------------------------------------
|
# -- Options for Epub output ---------------------------------------------------
|
||||||
|
|
|
||||||
41
docs/contents.rst.inc
Normal file
41
docs/contents.rst.inc
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
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
|
||||||
|
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
|
||||||
73
docs/flaskstyle.sty
Normal file
73
docs/flaskstyle.sty
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
\pagenumbering{arabic}
|
||||||
|
\definecolor{TitleColor}{rgb}{0,0,0}
|
||||||
|
\definecolor{InnerLinkColor}{rgb}{0,0,0}
|
||||||
|
|
||||||
|
\renewcommand{\maketitle}{%
|
||||||
|
\begin{titlepage}%
|
||||||
|
\let\footnotesize\small
|
||||||
|
\let\footnoterule\relax
|
||||||
|
\ifsphinxpdfoutput
|
||||||
|
\begingroup
|
||||||
|
% This \def is required to deal with multi-line authors; it
|
||||||
|
% changes \\ to ', ' (comma-space), making it pass muster for
|
||||||
|
% generating document info in the PDF file.
|
||||||
|
\def\\{, }
|
||||||
|
\pdfinfo{
|
||||||
|
/Author (\@author)
|
||||||
|
/Title (\@title)
|
||||||
|
}
|
||||||
|
\endgroup
|
||||||
|
\fi
|
||||||
|
\begin{flushright}%
|
||||||
|
%\sphinxlogo%
|
||||||
|
{\center
|
||||||
|
\vspace*{3cm}
|
||||||
|
\includegraphics{logo.pdf}
|
||||||
|
\vspace{3cm}
|
||||||
|
\par
|
||||||
|
{\rm\Huge \@title \par}%
|
||||||
|
{\em\LARGE \py@release\releaseinfo \par}
|
||||||
|
{\large
|
||||||
|
\@date \par
|
||||||
|
\py@authoraddress \par
|
||||||
|
}}%
|
||||||
|
\end{flushright}%\par
|
||||||
|
\@thanks
|
||||||
|
\end{titlepage}%
|
||||||
|
\cleardoublepage%
|
||||||
|
\setcounter{footnote}{0}%
|
||||||
|
\let\thanks\relax\let\maketitle\relax
|
||||||
|
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
|
||||||
|
}
|
||||||
|
|
||||||
|
\fancypagestyle{normal}{
|
||||||
|
\fancyhf{}
|
||||||
|
\fancyfoot[LE,RO]{{\thepage}}
|
||||||
|
\fancyfoot[LO]{{\nouppercase{\rightmark}}}
|
||||||
|
\fancyfoot[RE]{{\nouppercase{\leftmark}}}
|
||||||
|
\fancyhead[LE,RO]{{ \@title, \py@release}}
|
||||||
|
\renewcommand{\headrulewidth}{0.4pt}
|
||||||
|
\renewcommand{\footrulewidth}{0.4pt}
|
||||||
|
}
|
||||||
|
|
||||||
|
\fancypagestyle{plain}{
|
||||||
|
\fancyhf{}
|
||||||
|
\fancyfoot[LE,RO]{{\thepage}}
|
||||||
|
\renewcommand{\headrulewidth}{0pt}
|
||||||
|
\renewcommand{\footrulewidth}{0.4pt}
|
||||||
|
}
|
||||||
|
|
||||||
|
\titleformat{\section}{\Large}%
|
||||||
|
{\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
|
||||||
|
\titleformat{\subsection}{\large}%
|
||||||
|
{\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
|
||||||
|
\titleformat{\subsubsection}{}%
|
||||||
|
{\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
|
||||||
|
\titleformat{\paragraph}{\large}%
|
||||||
|
{\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor}
|
||||||
|
|
||||||
|
\ChNameVar{\raggedleft\normalsize}
|
||||||
|
\ChNumVar{\raggedleft \bfseries\Large}
|
||||||
|
\ChTitleVar{\raggedleft \rm\Huge}
|
||||||
|
|
||||||
|
\usepackage{inconsolata}
|
||||||
|
|
@ -25,44 +25,4 @@ following links:
|
||||||
.. _Jinja2: http://jinja.pocoo.org/2/
|
.. _Jinja2: http://jinja.pocoo.org/2/
|
||||||
.. _Werkzeug: http://werkzeug.pocoo.org/
|
.. _Werkzeug: http://werkzeug.pocoo.org/
|
||||||
|
|
||||||
User's Guide
|
.. include:: contents.rst.inc
|
||||||
------------
|
|
||||||
|
|
||||||
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
|
|
||||||
patterns/index
|
|
||||||
deploying/index
|
|
||||||
becomingbig
|
|
||||||
|
|
||||||
Additional Notes
|
|
||||||
----------------
|
|
||||||
|
|
||||||
Design notes, legal information and changelog are here for the interested:
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
design
|
|
||||||
license
|
|
||||||
changelog
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
|
||||||
4
docs/latexindex.rst
Normal file
4
docs/latexindex.rst
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
Flask Documentation
|
||||||
|
===================
|
||||||
|
|
||||||
|
.. include:: contents.rst.inc
|
||||||
BIN
docs/logo.pdf
Normal file
BIN
docs/logo.pdf
Normal file
Binary file not shown.
Loading…
Add table
Add a link
Reference in a new issue