Home | History | Annotate | Download | only in docs 
      1 # -*- coding: utf-8 -*-
      2 #
      3 # Paste documentation build configuration file, created by
      4 # sphinx-quickstart on Tue Apr 22 22:08:49 2008.
      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 
     14 import sys
     15 
     16 # If your extensions are in another directory, add it here.
     17 #sys.path.append('some/directory')
     18 
     19 # General configuration
     20 # ---------------------
     21 
     22 # Add any Sphinx extension module names here, as strings. They can be extensions
     23 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
     24 extensions = ['sphinx.ext.autodoc']
     25 
     26 # Add any paths that contain templates here, relative to this directory.
     27 templates_path = ['_templates']
     28 
     29 # The suffix of source filenames.
     30 source_suffix = '.txt'
     31 
     32 # The master toctree document.
     33 master_doc = 'index'
     34 
     35 # General substitutions.
     36 project = 'Paste'
     37 copyright = '2008, Ian Bicking'
     38 
     39 # The default replacements for |version| and |release|, also used in various
     40 # other places throughout the built documents.
     41 #
     42 # The short X.Y version.
     43 version = '1.7'
     44 # The full version, including alpha/beta/rc tags.
     45 release = '1.7.5.1'
     46 
     47 # There are two options for replacing |today|: either, you set today to some
     48 # non-false value, then it is used:
     49 #today = ''
     50 # Else, today_fmt is used as the format for a strftime call.
     51 today_fmt = '%B %d, %Y'
     52 
     53 # List of documents that shouldn't be included in the build.
     54 unused_docs = ['include/contact.txt', 'include/reference_header.txt']
     55 
     56 # If true, '()' will be appended to :func: etc. cross-reference text.
     57 #add_function_parentheses = True
     58 
     59 # If true, the current module name will be prepended to all description
     60 # unit titles (such as .. function::).
     61 #add_module_names = True
     62 
     63 # If true, sectionauthor and moduleauthor directives will be shown in the
     64 # output. They are ignored by default.
     65 #show_authors = False
     66 
     67 # The name of the Pygments (syntax highlighting) style to use.
     68 pygments_style = 'sphinx'
     69 
     70 
     71 # Options for HTML output
     72 # -----------------------
     73 
     74 # The style sheet to use for HTML and HTML Help pages. A file of that name
     75 # must exist either in Sphinx' static/ path, or in one of the custom paths
     76 # given in html_static_path.
     77 html_style = 'default.css'
     78 
     79 # Add any paths that contain custom static files (such as style sheets) here,
     80 # relative to this directory. They are copied after the builtin static files,
     81 # so a file named "default.css" will overwrite the builtin "default.css".
     82 html_static_path = ['_static']
     83 
     84 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
     85 # using the given strftime format.
     86 html_last_updated_fmt = '%b %d, %Y'
     87 
     88 # If true, SmartyPants will be used to convert quotes and dashes to
     89 # typographically correct entities.
     90 #html_use_smartypants = True
     91 
     92 # Content template for the index page.
     93 #html_index = ''
     94 
     95 # Custom sidebar templates, maps document names to template names.
     96 #html_sidebars = {}
     97 
     98 # Additional templates that should be rendered to pages, maps page names to
     99 # template names.
    100 #html_additional_pages = {}
    101 
    102 # If false, no module index is generated.
    103 #html_use_modindex = True
    104 
    105 # If true, the reST sources are included in the HTML build as _sources/<name>.
    106 #html_copy_source = True
    107 
    108 # Output file base name for HTML help builder.
    109 htmlhelp_basename = 'Pastedoc'
    110 
    111 
    112 # Options for LaTeX output
    113 # ------------------------
    114 
    115 # The paper size ('letter' or 'a4').
    116 #latex_paper_size = 'letter'
    117 
    118 # The font size ('10pt', '11pt' or '12pt').
    119 #latex_font_size = '10pt'
    120 
    121 # Grouping the document tree into LaTeX files. List of tuples
    122 # (source start file, target name, title, author, document class [howto/manual]).
    123 #latex_documents = []
    124 
    125 # Additional stuff for the LaTeX preamble.
    126 #latex_preamble = ''
    127 
    128 # Documents to append as an appendix to all manuals.
    129 #latex_appendices = []
    130 
    131 # If false, no module index is generated.
    132 #latex_use_modindex = True
    133