| commit | author | age | ||
| f70c23 | 1 | # -*- coding: utf-8 -*- |
| CM | 2 | # |
| edd915 | 3 | # pyramid documentation build configuration file, created by |
| f70c23 | 4 | # sphinx-quickstart on Wed Jul 16 13:18:14 2008. |
| CM | 5 | # |
| 6 | # This file is execfile()d with the current directory set to its containing dir. | |
| 7 | # | |
| 8 | # The contents of this file are pickled, so don't put values in the namespace | |
| 9 | # that aren't pickleable (module imports are okay, they're removed automatically). | |
| 10 | # | |
| 11 | # All configuration values have a default value; values that are commented out | |
| 12 | # serve to show the default value. | |
| 13 | ||
| c8b363 | 14 | import sys |
| M | 15 | import os |
| 52d4fb | 16 | import datetime |
| be5f12 | 17 | import inspect |
| 50fb10 | 18 | import warnings |
| CM | 19 | |
| 20 | warnings.simplefilter('ignore', DeprecationWarning) | |
| f70c23 | 21 | |
| 95d5b7 | 22 | import pkg_resources |
| 71d66b | 23 | import pylons_sphinx_themes |
| 95d5b7 | 24 | |
| 6cdedf | 25 | # skip raw nodes |
| CM | 26 | from sphinx.writers.text import TextTranslator |
| 43889a | 27 | from sphinx.writers.latex import LaTeXTranslator |
| CM | 28 | |
| 6cdedf | 29 | from docutils import nodes |
| fd5ae9 | 30 | from docutils import utils |
| CM | 31 | |
| 09f43d | 32 | |
| 6cdedf | 33 | def raw(*arg): |
| CM | 34 | raise nodes.SkipNode |
| 35 | TextTranslator.visit_raw = raw | |
| 36 | ||
| 43889a | 37 | |
| CM | 38 | # make sure :app:`Pyramid` doesn't mess up LaTeX rendering |
| 39 | def nothing(*arg): | |
| 40 | pass | |
| 41 | LaTeXTranslator.visit_inline = nothing | |
| 42 | LaTeXTranslator.depart_inline = nothing | |
| 43 | ||
| d22e8d | 44 | book = os.environ.get('BOOK') |
| 274778 | 45 | |
| f70c23 | 46 | # General configuration |
| CM | 47 | # --------------------- |
| 48 | ||
| 49 | # Add any Sphinx extension module names here, as strings. They can be extensions | |
| 50 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
| 8864e0 | 51 | extensions = [ |
| 5225f9 | 52 | 'repoze.sphinx.autointerface', |
| 8864e0 | 53 | 'sphinx.ext.autodoc', |
| CM | 54 | 'sphinx.ext.doctest', |
| b7f994 | 55 | 'sphinx.ext.intersphinx', |
| 79f067 | 56 | 'sphinx.ext.todo', |
| 5225f9 | 57 | 'sphinx.ext.viewcode', |
| MM | 58 | 'sphinxcontrib.autoprogram', |
| 48738d | 59 | # enable pylons_sphinx_latesturl when this branch is no longer "latest" |
| 07ecae | 60 | 'pylons_sphinx_latesturl', |
| 8864e0 | 61 | ] |
| CM | 62 | |
| 182686 | 63 | # Looks for objects in external projects |
| TL | 64 | intersphinx_mapping = { |
| 1c561a | 65 | 'colander': ('https://docs.pylonsproject.org/projects/colander/en/latest', None), |
| SP | 66 | 'cookbook': ('https://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/', None), |
| acab34 | 67 | 'cookiecutter': ('https://cookiecutter.readthedocs.io/en/latest/', None), |
| 1c561a | 68 | 'deform': ('https://docs.pylonsproject.org/projects/deform/en/latest', None), |
| SP | 69 | 'jinja2': ('https://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None), |
| 70 | 'pylonswebframework': ('https://docs.pylonsproject.org/projects/pylons-webframework/en/latest/', None), | |
| 186b72 | 71 | 'python': ('https://docs.python.org/3', None), |
| ac5420 | 72 | 'pytest': ('https://docs.pytest.org/en/latest/', None), |
| 90db2b | 73 | 'sphinx': ('http://www.sphinx-doc.org/en/latest', None), |
| 82862b | 74 | 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), |
| 1c561a | 75 | 'tm': ('https://docs.pylonsproject.org/projects/pyramid-tm/en/latest/', None), |
| SP | 76 | 'toolbar': ('https://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), |
| 77 | 'tstring': ('https://docs.pylonsproject.org/projects/translationstring/en/latest', None), | |
| 78 | 'tutorials': ('https://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None), | |
| 79 | 'venusian': ('https://docs.pylonsproject.org/projects/venusian/en/latest', None), | |
| 5e4d8e | 80 | 'webob': ('https://docs.pylonsproject.org/projects/webob/en/latest/', None), |
| 82862b | 81 | 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), |
| ac5420 | 82 | 'who': ('http://repozewho.readthedocs.io/en/latest', None), |
| 1c561a | 83 | 'zcml': ('https://docs.pylonsproject.org/projects/pyramid-zcml/en/latest', None), |
| 5e20f9 | 84 | 'zcomponent': ('http://zopecomponent.readthedocs.io/en/latest/', None), |
| MM | 85 | 'zinterface': ('http://zopeinterface.readthedocs.io/en/latest/', None), |
| 182686 | 86 | } |
| f70c23 | 87 | |
| b1b922 | 88 | |
| f70c23 | 89 | # Add any paths that contain templates here, relative to this directory. |
| 785d2f | 90 | templates_path = ['_templates'] |
| f70c23 | 91 | |
| CM | 92 | # The suffix of source filenames. |
| 93 | source_suffix = '.rst' | |
| 94 | ||
| 95 | # The master toctree document. | |
| 96 | master_doc = 'index' | |
| 97 | ||
| 98 | # General substitutions. | |
| 83fefb | 99 | project = 'The Pyramid Web Framework' |
| 3604e6 | 100 | thisyear = datetime.datetime.now().year |
| TL | 101 | copyright = '2008-%s, Agendaless Consulting' % thisyear |
| f70c23 | 102 | |
| CM | 103 | # The default replacements for |version| and |release|, also used in various |
| 104 | # other places throughout the built documents. | |
| 105 | # | |
| 106 | # The short X.Y version. | |
| 95d5b7 | 107 | version = pkg_resources.get_distribution('pyramid').version |
| 3ee102 | 108 | |
| f70c23 | 109 | # The full version, including alpha/beta/rc tags. |
| c0114e | 110 | release = version |
| f70c23 | 111 | |
| CM | 112 | # There are two options for replacing |today|: either, you set today to some |
| 113 | # non-false value, then it is used: | |
| 114 | #today = '' | |
| 115 | # Else, today_fmt is used as the format for a strftime call. | |
| 116 | today_fmt = '%B %d, %Y' | |
| 117 | ||
| 4ac753 | 118 | # List of patterns, relative to source directory, that match files and |
| M | 119 | # directories to ignore when looking for source files. |
| 09f43d | 120 | exclude_patterns = ['_themes/README.rst', ] |
| f70c23 | 121 | |
| CM | 122 | # If true, the current module name will be prepended to all description |
| 123 | # unit titles (such as .. function::). | |
| e4e3aa | 124 | add_module_names = False |
| f70c23 | 125 | |
| bf5c9e | 126 | # Add support for todo items |
| SP | 127 | todo_include_todos = True |
| 128 | ||
| f70c23 | 129 | # The name of the Pygments (syntax highlighting) style to use. |
| 957548 | 130 | #pygments_style = book and 'bw' or 'tango' |
| 5845bc | 131 | if book: |
| CM | 132 | pygments_style = 'bw' |
| 002c0c | 133 | |
| f70c23 | 134 | # Options for HTML output |
| CM | 135 | # ----------------------- |
| 48738d | 136 | # enable pylons_sphinx_latesturl when this branch is no longer "latest" |
| 07ecae | 137 | pylons_sphinx_latesturl_base = ( |
| MM | 138 | 'https://docs.pylonsproject.org/projects/pyramid/en/latest/') |
| 139 | pylons_sphinx_latesturl_pagename_overrides = { | |
| 140 | # map old pagename -> new pagename | |
| 141 | 'whatsnew-1.0': 'index', | |
| 142 | 'whatsnew-1.1': 'index', | |
| 143 | 'whatsnew-1.2': 'index', | |
| 144 | 'whatsnew-1.3': 'index', | |
| 145 | 'whatsnew-1.4': 'index', | |
| 146 | 'whatsnew-1.5': 'index', | |
| 147 | 'whatsnew-1.6': 'index', | |
| 148 | 'whatsnew-1.7': 'index', | |
| 149 | 'whatsnew-1.8': 'index', | |
| 150 | 'tutorials/gae/index': 'index', | |
| 151 | 'api/chameleon_text': 'api', | |
| 152 | 'api/chameleon_zpt': 'api', | |
| 153 | } | |
| f70c23 | 154 | |
| cc19a8 | 155 | html_theme = 'pyramid' |
| 71d66b | 156 | html_theme_path = pylons_sphinx_themes.get_html_themes_path() |
| d0a257 | 157 | html_theme_options = dict( |
| 862a26 | 158 | github_url='https://github.com/Pylons/pyramid', |
| 7c9eab | 159 | # On master branch and new branch still in |
| SP | 160 | # pre-release status: true; else: false. |
| 48411c | 161 | in_progress='false', |
| 7c9eab | 162 | # On branches previous to "latest": true; else: false. |
| 07ecae | 163 | outdated='true', |
| d0a257 | 164 | ) |
| f70c23 | 165 | |
| CM | 166 | # The name for this set of Sphinx documents. If None, it defaults to |
| 167 | # "<project> v<release> documentation". | |
| 83fefb | 168 | html_title = 'The Pyramid Web Framework v%s' % release |
| f70c23 | 169 | |
| CM | 170 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 171 | # using the given strftime format. | |
| 172 | html_last_updated_fmt = '%b %d, %Y' | |
| 173 | ||
| 433f1f | 174 | # Do not use smart quotes. |
| SP | 175 | smartquotes = False |
| 176 | ||
| f70c23 | 177 | # Output file base name for HTML help builder. |
| 71ff10 | 178 | htmlhelp_basename = 'pyramid' |
| f70c23 | 179 | |
| CM | 180 | # Options for LaTeX output |
| 181 | # ------------------------ | |
| 182 | ||
| 183 | # The paper size ('letter' or 'a4'). | |
| 67bfd8 | 184 | latex_paper_size = 'letter' |
| f70c23 | 185 | |
| CM | 186 | # The font size ('10pt', '11pt' or '12pt'). |
| 67bfd8 | 187 | latex_font_size = '10pt' |
| f70c23 | 188 | |
| 7673b0 | 189 | latex_additional_files = ['_static/latex-note.png', '_static/latex-warning.png'] |
| LMC | 190 | |
| f70c23 | 191 | # Grouping the document tree into LaTeX files. List of tuples |
| CM | 192 | # (source start file, target name, title, author, document class [howto/manual]). |
| 193 | latex_documents = [ | |
| 71ff10 | 194 | ('latexindex', 'pyramid.tex', |
| 83fefb | 195 | 'The Pyramid Web Framework', |
| 8be78e | 196 | 'Chris McDonough', 'manual'), |
| CM | 197 | ] |
| f70c23 | 198 | |
| CM | 199 | # For "manual" documents, if this is true, then toplevel headings are parts, |
| 200 | # not chapters. | |
| 11d637 | 201 | latex_toplevel_sectioning = "section" |
| f70c23 | 202 | |
| CM | 203 | # If false, no module index is generated. |
| 11d637 | 204 | latex_domain_indices = False |
| 125e97 | 205 | |
| CM | 206 | ## Say, for a moment that you have a twoside document that needs a 3cm |
| 207 | ## inner margin to allow for binding and at least two centimetres the | |
| 208 | ## rest of the way around. You've been using the a4wide package up until | |
| 209 | ## now, because you like the amount of text it places on the | |
| 210 | ## page. Perhaps try something like this in your preamble: | |
| 211 | ||
| 212 | ## \usepackage[bindingoffset=1cm,textheight=22cm,hdivide={2cm,*,2cm},vdivide={*,22cm,*}]{geometry} | |
| 213 | ||
| f2086c | 214 | ## _PREAMBLE = r"""\usepackage[bindingoffset=0.45in,textheight=7.25in,hdivide={0.5in,*,0.75in},vdivide={1in,7.25in,1in},papersize={7.5in,9.25in}]{geometry}""" |
| 125e97 | 215 | |
| f2086c | 216 | _PREAMBLE = r""" |
| CM | 217 | \usepackage[]{geometry} |
| 218 | \geometry{bindingoffset=0.45in,textheight=7.25in,hdivide={0.5in,*,0.75in},vdivide={1in,7.25in,1in},papersize={7.5in,9.25in}} | |
| 219 | \hypersetup{ | |
| 220 | colorlinks=true, | |
| 221 | linkcolor=black, | |
| 222 | citecolor=black, | |
| 223 | filecolor=black, | |
| 224 | urlcolor=black | |
| 225 | } | |
| 274778 | 226 | \fvset{frame=single,xleftmargin=9pt,numbersep=4pt} |
| f2086c | 227 | |
| CM | 228 | \pagestyle{fancy} |
| 229 | ||
| 9ec2d6 | 230 | % header and footer styles |
| f2086c | 231 | \renewcommand{\chaptermark}[1]% |
| 9ec2d6 | 232 | {\markboth{\MakeUppercase{\thechapter.\ #1}}{} |
| CM | 233 | } |
| f2086c | 234 | \renewcommand{\sectionmark}[1]% |
| 9ec2d6 | 235 | {\markright{\MakeUppercase{\thesection.\ #1}} |
| CM | 236 | } |
| 237 | ||
| 238 | % defaults for fancy style | |
| 239 | \renewcommand{\headrulewidth}{0pt} | |
| f2086c | 240 | \renewcommand{\footrulewidth}{0pt} |
| CM | 241 | \fancyhf{} |
| 242 | \fancyfoot[C]{\thepage} | |
| 243 | ||
| 9ec2d6 | 244 | % plain style |
| f2086c | 245 | \fancypagestyle{plain}{ |
| CM | 246 | \renewcommand{\headrulewidth}{0pt} % ho header line |
| 9ec2d6 | 247 | \renewcommand{\footrulewidth}{0pt}% no footer line |
| CM | 248 | \fancyhf{} % empty header and footer |
| 249 | \fancyfoot[C]{\thepage} | |
| f2086c | 250 | } |
| 3a4e6f | 251 | |
| 9ec2d6 | 252 | % title page styles |
| 3a4e6f | 253 | \makeatletter |
| CM | 254 | \def\@subtitle{\relax} |
| 255 | \newcommand{\subtitle}[1]{\gdef\@subtitle{#1}} | |
| 256 | \renewcommand{\maketitle}{ | |
| 257 | \begin{titlepage} | |
| 258 | {\rm\Huge\@title\par} | |
| 259 | {\em\large\py@release\releaseinfo\par} | |
| 260 | \if\@subtitle\relax\else\large\@subtitle\par\fi | |
| 261 | {\large\@author\par} | |
| 262 | \end{titlepage} | |
| 263 | } | |
| 264 | \makeatother | |
| 265 | ||
| 9ec2d6 | 266 | % Redefine link and title colors |
| 793425 | 267 | \definecolor{TitleColor}{rgb}{0,0,0} |
| CM | 268 | \definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486} |
| 269 | \definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388} | |
| 270 | % Redefine these colors to something not white if you want to have colored | |
| 271 | % background and border for code examples. | |
| 272 | \definecolor{VerbatimColor}{rgb}{1,1,1} | |
| 273 | \definecolor{VerbatimBorderColor}{rgb}{1,1,1} | |
| 274 | ||
| 275 | \makeatletter | |
| dc0ba7 | 276 | \renewcommand{\py@noticestart@warning}{\py@heavybox} |
| CM | 277 | \renewcommand{\py@noticeend@warning}{\py@endheavybox} |
| 793425 | 278 | \renewcommand{\py@noticestart@note}{\py@heavybox} |
| CM | 279 | \renewcommand{\py@noticeend@note}{\py@endheavybox} |
| 280 | \makeatother | |
| 281 | ||
| 9ec2d6 | 282 | % icons in note and warning boxes |
| dc0ba7 | 283 | \usepackage{ifthen} |
| CM | 284 | % Keep a copy of the original notice environment |
| 285 | \let\origbeginnotice\notice | |
| 286 | \let\origendnotice\endnotice | |
| 287 | ||
| 288 | % Redefine the notice environment so we can add our own code to it | |
| 289 | \renewenvironment{notice}[2]{% | |
| 290 | \origbeginnotice{#1}{}% equivalent to original \begin{notice}{#1}{#2} | |
| 291 | % load graphics | |
| de8c1b | 292 | \ifthenelse{\equal{#1}{warning}}{\includegraphics{latex-warning.png}}{} |
| BL | 293 | \ifthenelse{\equal{#1}{note}}{\includegraphics{latex-note.png}}{} |
| dc0ba7 | 294 | % etc. |
| CM | 295 | }{% |
| 296 | \origendnotice% equivalent to original \end{notice} | |
| 297 | } | |
| 298 | ||
| 9ec2d6 | 299 | % try to prevent code-block boxes from splitting across pages |
| 44f1df | 300 | \sloppy |
| 9ec2d6 | 301 | \widowpenalty=300 |
| CM | 302 | \clubpenalty=300 |
| 303 | \setlength{\parskip}{3ex plus 2ex minus 2ex} | |
| 304 | ||
| 305 | % suppress page numbers on pages showing part title | |
| 306 | \makeatletter | |
| 307 | \let\sv@endpart\@endpart | |
| 308 | \def\@endpart{\thispagestyle{empty}\sv@endpart} | |
| 309 | \makeatother | |
| 310 | ||
| 311 | % prevent page numbers in TOC (reset to fancy by frontmatter directive) | |
| 312 | \pagestyle{empty} | |
| f2086c | 313 | """ |
| 125e97 | 314 | |
| CM | 315 | latex_elements = { |
| f2086c | 316 | 'preamble': _PREAMBLE, |
| 09f43d | 317 | 'wrapperclass': 'book', |
| GC | 318 | 'date': '', |
| 319 | 'releasename': 'Version', | |
| 63bac4 | 320 | 'title': r'The Pyramid Web Framework', |
| 9544d0 | 321 | # 'pointsize':'12pt', # uncomment for 12pt version |
| f2086c | 322 | } |
| CM | 323 | |
| 9ec2d6 | 324 | # secnumdepth counter reset to 2 causes numbering in related matter; |
| CM | 325 | # reset to -1 causes chapters to not be numbered, reset to -2 causes |
| 326 | # parts to not be numbered. | |
| 327 | ||
| 328 | #part -1 | |
| 329 | #chapter 0 | |
| 330 | #section 1 | |
| 331 | #subsection 2 | |
| 332 | #subsubsection 3 | |
| 333 | #paragraph 4 | |
| 334 | #subparagraph 5 | |
| 09f43d | 335 | |
| 9ec2d6 | 336 | |
| f2086c | 337 | def frontmatter(name, arguments, options, content, lineno, |
| CM | 338 | content_offset, block_text, state, state_machine): |
| 9ec2d6 | 339 | return [nodes.raw( |
| CM | 340 | '', |
| 341 | r""" | |
| 342 | \frontmatter | |
| 343 | % prevent part/chapter/section numbering | |
| 344 | \setcounter{secnumdepth}{-2} | |
| 345 | % suppress headers | |
| 346 | \pagestyle{plain} | |
| 347 | % reset page counter | |
| 348 | \setcounter{page}{1} | |
| 349 | % suppress first toc pagenum | |
| c8b363 | 350 | \addtocontents{toc}{\protect\thispagestyle{empty}} |
| 9ec2d6 | 351 | """, |
| CM | 352 | format='latex')] |
| 09f43d | 353 | |
| f2086c | 354 | |
| CM | 355 | def mainmatter(name, arguments, options, content, lineno, |
| 356 | content_offset, block_text, state, state_machine): | |
| 9ec2d6 | 357 | return [nodes.raw( |
| CM | 358 | '', |
| 359 | r""" | |
| 360 | \mainmatter | |
| 361 | % allow part/chapter/section numbering | |
| 362 | \setcounter{secnumdepth}{2} | |
| 363 | % get headers back | |
| c8b363 | 364 | \pagestyle{fancy} |
| 9ec2d6 | 365 | \fancyhf{} |
| CM | 366 | \renewcommand{\headrulewidth}{0.5pt} |
| 367 | \renewcommand{\footrulewidth}{0pt} | |
| 368 | \fancyfoot[C]{\thepage} | |
| 369 | \fancyhead[RO]{\rightmark} | |
| 370 | \fancyhead[LE]{\leftmark} | |
| 371 | """, | |
| 372 | format='latex')] | |
| f2086c | 373 | |
| 09f43d | 374 | |
| f2086c | 375 | def backmatter(name, arguments, options, content, lineno, |
| CM | 376 | content_offset, block_text, state, state_machine): |
| 9ec2d6 | 377 | return [nodes.raw('', '\\backmatter\n\\setcounter{secnumdepth}{-1}\n', |
| CM | 378 | format='latex')] |
| 09f43d | 379 | |
| f2086c | 380 | |
| fd5ae9 | 381 | def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]): |
| CM | 382 | """custom role for :app: marker, does nothing in particular except allow |
| 383 | :app:`Pyramid` to work (for later search and replace).""" | |
| 384 | if 'class' in options: | |
| 385 | assert 'classes' not in options | |
| 386 | options['classes'] = options['class'] | |
| 387 | del options['class'] | |
| 388 | return [nodes.inline(rawtext, utils.unescape(text), **options)], [] | |
| 389 | ||
| 390 | ||
| f2086c | 391 | def setup(app): |
| fd5ae9 | 392 | app.add_role('app', app_role) |
| f2086c | 393 | app.add_directive('frontmatter', frontmatter, 1, (0, 0, 0)) |
| CM | 394 | app.add_directive('mainmatter', mainmatter, 1, (0, 0, 0)) |
| 395 | app.add_directive('backmatter', backmatter, 1, (0, 0, 0)) | |
| be5f12 | 396 | app.connect('autodoc-process-signature', resig) |
| 09f43d | 397 | |
| be5f12 | 398 | |
| CM | 399 | def resig(app, what, name, obj, options, signature, return_annotation): |
| 400 | """ Allow for preservation of ``@action_method`` decorated methods | |
| 401 | in configurator """ | |
| 402 | docobj = getattr(obj, '__docobj__', None) | |
| 403 | if docobj is not None: | |
| 404 | argspec = inspect.getargspec(docobj) | |
| 405 | if argspec[0] and argspec[0][0] in ('cls', 'self'): | |
| 406 | del argspec[0][0] | |
| 407 | signature = inspect.formatargspec(*argspec) | |
| 408 | return signature, return_annotation | |
| 016a1f | 409 | |
| 274778 | 410 | # turn off all line numbers in latex formatting |
| CM | 411 | |
| 412 | ## from pygments.formatters import LatexFormatter | |
| 413 | ## from sphinx.highlighting import PygmentsBridge | |
| 414 | ||
| 415 | ## class NoLinenosLatexFormatter(LatexFormatter): | |
| 416 | ## def __init__(self, **options): | |
| 417 | ## LatexFormatter.__init__(self, **options) | |
| 418 | ## self.linenos = False | |
| 419 | ||
| 420 | ## PygmentsBridge.latex_formatter = NoLinenosLatexFormatter | |
| 6d47bc | 421 | |
| CM | 422 | # -- Options for Epub output --------------------------------------------------- |
| 423 | ||
| 424 | # Bibliographic Dublin Core info. | |
| 83fefb | 425 | epub_title = 'The Pyramid Web Framework, Version %s' \ |
| 09f43d | 426 | % release |
| 6d47bc | 427 | epub_author = 'Chris McDonough' |
| CM | 428 | epub_publisher = 'Agendaless Consulting' |
| 3604e6 | 429 | epub_copyright = '2008-%d' % thisyear |
| 6d47bc | 430 | |
| CM | 431 | # The language of the text. It defaults to the language option |
| 432 | # or en if the language is not set. | |
| 433 | epub_language = 'en' | |
| 434 | ||
| 435 | # The scheme of the identifier. Typical schemes are ISBN or URL. | |
| 436 | epub_scheme = 'ISBN' | |
| 437 | ||
| 438 | # The unique identifier of the text. This can be a ISBN number | |
| 439 | # or the project homepage. | |
| 5236f3 | 440 | epub_identifier = '0615445675' |
| 6d47bc | 441 | |
| CM | 442 | # A unique identification for the text. |
| 83fefb | 443 | epub_uid = 'The Pyramid Web Framework, Version %s' \ |
| 09f43d | 444 | % release |
| 6d47bc | 445 | |
| CM | 446 | # A list of files that should not be packed into the epub file. |
| c8b363 | 447 | epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', |
| M | 448 | '_static/jquery.js', '_static/searchtools.js', '_static/underscore.js', |
| 09f43d | 449 | '_static/basic.css', 'search.html', '_static/websupport.js'] |
| c8b363 | 450 | |
| 6d47bc | 451 | |
| CM | 452 | # The depth of the table of contents in toc.ncx. |
| 453 | epub_tocdepth = 3 | |
| 0435cc | 454 | |
| 6a3eed | 455 | # For a list of all settings, visit http://sphinx-doc.org/config.html |
