Permalink
Browse files

Beefed up PDF docs. They actually look like something now.

  • Loading branch information...
1 parent 4395e94 commit 3ac4ec670c881668aaedb2c3937bae5e10984988 @mitsuhiko mitsuhiko committed Apr 25, 2010
Showing with 130 additions and 60 deletions.
  1. +11 −19 docs/conf.py
  2. +41 −0 docs/contents.rst
  3. +73 −0 docs/flaskstyle.sty
  4. +1 −41 docs/index.rst
  5. +4 −0 docs/latexindex.rst
  6. BIN docs/logo.pdf
View
@@ -172,35 +172,27 @@
# -- 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
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'Flask.tex', u'Flask Documentation',
+ ('latexindex', 'Flask.tex', u'Flask Documentation',
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.
#latex_appendices = []
# 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 ---------------------------------------------------
View
@@ -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
+
+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
View
@@ -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}
View
@@ -25,44 +25,4 @@ following links:
.. _Jinja2: http://jinja.pocoo.org/2/
.. _Werkzeug: http://werkzeug.pocoo.org/
-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
-
-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
+.. include:: contents.rst
View
@@ -0,0 +1,4 @@
+Flask Documentation
+===================
+
+.. include:: contents.rst
View
Binary file not shown.

0 comments on commit 3ac4ec6

Please sign in to comment.