"Fossies" - the Fresh Open Source Software Archive

Member "xhtml2pdf-0.2.2/doc/source/conf.py" (16 Apr 2018, 12153 Bytes) of package /linux/www/xhtml2pdf-0.2.2.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Python source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "conf.py" see the Fossies "Dox" file reference documentation.

    1 # -*- coding: utf-8 -*-
    2 #
    3 # xhtml2pdf documentation build configuration file, created by
    4 # sphinx-quickstart on Thu Nov 17 21:20:59 2016.
    5 #
    6 # This file is execfile()d with the current directory set to its
    7 # containing dir.
    8 #
    9 # Note that not all possible configuration values are present in this
   10 # autogenerated file.
   11 #
   12 # All configuration values have a default; values that are commented out
   13 # serve to show the default.
   14 
   15 # If extensions (or modules to document with autodoc) are in another directory,
   16 # add these directories to sys.path here. If the directory is relative to the
   17 # documentation root, use os.path.abspath to make it absolute, like shown here.
   18 #
   19 # import os
   20 # import sys
   21 # sys.path.insert(0, os.path.abspath('.'))
   22 
   23 # -- General configuration ------------------------------------------------
   24 
   25 # If your documentation needs a minimal Sphinx version, state it here.
   26 #
   27 # needs_sphinx = '1.0'
   28 
   29 # Add any Sphinx extension module names here, as strings. They can be
   30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   31 # ones.
   32 extensions = [
   33     'sphinx.ext.autodoc',
   34     'sphinx.ext.doctest',
   35     'sphinx.ext.intersphinx',
   36     'sphinx.ext.todo',
   37     'sphinx.ext.coverage',
   38     'sphinx.ext.viewcode',
   39     'sphinx.ext.githubpages',
   40 ]
   41 
   42 # Add any paths that contain templates here, relative to this directory.
   43 templates_path = ['_templates']
   44 
   45 # The suffix(es) of source filenames.
   46 # You can specify multiple suffix as a list of string:
   47 #
   48 # source_suffix = ['.rst', '.md']
   49 source_suffix = '.rst'
   50 
   51 # The encoding of source files.
   52 #
   53 # source_encoding = 'utf-8-sig'
   54 
   55 # The master toctree document.
   56 master_doc = 'index'
   57 
   58 # General information about the project.
   59 project = u'xhtml2pdf'
   60 copyright = u'2016, xhtml2pdf'
   61 author = u'xhtml2pdf'
   62 
   63 # The version info for the project you're documenting, acts as replacement for
   64 # |version| and |release|, also used in various other places throughout the
   65 # built documents.
   66 #
   67 # The short X.Y version.
   68 version = u'0.1b3'
   69 # The full version, including alpha/beta/rc tags.
   70 release = u'0.1b3'
   71 
   72 # The language for content autogenerated by Sphinx. Refer to documentation
   73 # for a list of supported languages.
   74 #
   75 # This is also used if you do content translation via gettext catalogs.
   76 # Usually you set "language" from the command line for these cases.
   77 language = None
   78 
   79 # There are two options for replacing |today|: either, you set today to some
   80 # non-false value, then it is used:
   81 #
   82 # today = ''
   83 #
   84 # Else, today_fmt is used as the format for a strftime call.
   85 #
   86 # today_fmt = '%B %d, %Y'
   87 
   88 # List of patterns, relative to source directory, that match files and
   89 # directories to ignore when looking for source files.
   90 # This patterns also effect to html_static_path and html_extra_path
   91 exclude_patterns = []
   92 
   93 # The reST default role (used for this markup: `text`) to use for all
   94 # documents.
   95 #
   96 # default_role = None
   97 
   98 # If true, '()' will be appended to :func: etc. cross-reference text.
   99 #
  100 # add_function_parentheses = True
  101 
  102 # If true, the current module name will be prepended to all description
  103 # unit titles (such as .. function::).
  104 #
  105 # add_module_names = True
  106 
  107 # If true, sectionauthor and moduleauthor directives will be shown in the
  108 # output. They are ignored by default.
  109 #
  110 # show_authors = False
  111 
  112 # The name of the Pygments (syntax highlighting) style to use.
  113 pygments_style = 'sphinx'
  114 
  115 # A list of ignored prefixes for module index sorting.
  116 # modindex_common_prefix = []
  117 
  118 # If true, keep warnings as "system message" paragraphs in the built documents.
  119 # keep_warnings = False
  120 
  121 # If true, `todo` and `todoList` produce output, else they produce nothing.
  122 todo_include_todos = True
  123 
  124 
  125 # -- Options for HTML output ----------------------------------------------
  126 
  127 # The theme to use for HTML and HTML Help pages.  See the documentation for
  128 # a list of builtin themes.
  129 #
  130 html_theme = 'sphinx_rtd_theme'
  131 
  132 # Theme options are theme-specific and customize the look and feel of a theme
  133 # further.  For a list of options available for each theme, see the
  134 # documentation.
  135 #
  136 # html_theme_options = {}
  137 
  138 # Add any paths that contain custom themes here, relative to this directory.
  139 # html_theme_path = []
  140 
  141 # The name for this set of Sphinx documents.
  142 # "<project> v<release> documentation" by default.
  143 #
  144 # html_title = u'xhtml2pdf v0.1b3'
  145 
  146 # A shorter title for the navigation bar.  Default is the same as html_title.
  147 #
  148 # html_short_title = None
  149 
  150 # The name of an image file (relative to this directory) to place at the top
  151 # of the sidebar.
  152 #
  153 # html_logo = None
  154 
  155 # The name of an image file (relative to this directory) to use as a favicon of
  156 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  157 # pixels large.
  158 #
  159 # html_favicon = None
  160 
  161 # Add any paths that contain custom static files (such as style sheets) here,
  162 # relative to this directory. They are copied after the builtin static files,
  163 # so a file named "default.css" will overwrite the builtin "default.css".
  164 html_static_path = ['_static']
  165 
  166 # Add any extra paths that contain custom files (such as robots.txt or
  167 # .htaccess) here, relative to this directory. These files are copied
  168 # directly to the root of the documentation.
  169 #
  170 # html_extra_path = []
  171 
  172 # If not None, a 'Last updated on:' timestamp is inserted at every page
  173 # bottom, using the given strftime format.
  174 # The empty string is equivalent to '%b %d, %Y'.
  175 #
  176 # html_last_updated_fmt = None
  177 
  178 # If true, SmartyPants will be used to convert quotes and dashes to
  179 # typographically correct entities.
  180 #
  181 # html_use_smartypants = True
  182 
  183 # Custom sidebar templates, maps document names to template names.
  184 #
  185 # html_sidebars = {}
  186 
  187 # Additional templates that should be rendered to pages, maps page names to
  188 # template names.
  189 #
  190 # html_additional_pages = {}
  191 
  192 # If false, no module index is generated.
  193 #
  194 # html_domain_indices = True
  195 
  196 # If false, no index is generated.
  197 #
  198 # html_use_index = True
  199 
  200 # If true, the index is split into individual pages for each letter.
  201 #
  202 # html_split_index = False
  203 
  204 # If true, links to the reST sources are added to the pages.
  205 #
  206 # html_show_sourcelink = True
  207 
  208 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  209 #
  210 # html_show_sphinx = True
  211 
  212 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  213 #
  214 # html_show_copyright = True
  215 
  216 # If true, an OpenSearch description file will be output, and all pages will
  217 # contain a <link> tag referring to it.  The value of this option must be the
  218 # base URL from which the finished HTML is served.
  219 #
  220 # html_use_opensearch = ''
  221 
  222 # This is the file name suffix for HTML files (e.g. ".xhtml").
  223 # html_file_suffix = None
  224 
  225 # Language to be used for generating the HTML full-text search index.
  226 # Sphinx supports the following languages:
  227 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
  228 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
  229 #
  230 # html_search_language = 'en'
  231 
  232 # A dictionary with options for the search language support, empty by default.
  233 # 'ja' uses this config value.
  234 # 'zh' user can custom change `jieba` dictionary path.
  235 #
  236 # html_search_options = {'type': 'default'}
  237 
  238 # The name of a javascript file (relative to the configuration directory) that
  239 # implements a search results scorer. If empty, the default will be used.
  240 #
  241 # html_search_scorer = 'scorer.js'
  242 
  243 # Output file base name for HTML help builder.
  244 htmlhelp_basename = 'xhtml2pdfdoc'
  245 
  246 # -- Options for LaTeX output ---------------------------------------------
  247 
  248 latex_elements = {
  249      # The paper size ('letterpaper' or 'a4paper').
  250      #
  251      # 'papersize': 'letterpaper',
  252 
  253      # The font size ('10pt', '11pt' or '12pt').
  254      #
  255      # 'pointsize': '10pt',
  256 
  257      # Additional stuff for the LaTeX preamble.
  258      #
  259      # 'preamble': '',
  260 
  261      # Latex figure (float) alignment
  262      #
  263      # 'figure_align': 'htbp',
  264 }
  265 
  266 # Grouping the document tree into LaTeX files. List of tuples
  267 # (source start file, target name, title,
  268 #  author, documentclass [howto, manual, or own class]).
  269 latex_documents = [
  270     (master_doc, 'xhtml2pdf.tex', u'xhtml2pdf Documentation',
  271      u'xhtml2pdf', 'manual'),
  272 ]
  273 
  274 # The name of an image file (relative to this directory) to place at the top of
  275 # the title page.
  276 #
  277 # latex_logo = None
  278 
  279 # For "manual" documents, if this is true, then toplevel headings are parts,
  280 # not chapters.
  281 #
  282 # latex_use_parts = False
  283 
  284 # If true, show page references after internal links.
  285 #
  286 # latex_show_pagerefs = False
  287 
  288 # If true, show URL addresses after external links.
  289 #
  290 # latex_show_urls = False
  291 
  292 # Documents to append as an appendix to all manuals.
  293 #
  294 # latex_appendices = []
  295 
  296 # It false, will not define \strong, \code,     itleref, \crossref ... but only
  297 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
  298 # packages.
  299 #
  300 # latex_keep_old_macro_names = True
  301 
  302 # If false, no module index is generated.
  303 #
  304 # latex_domain_indices = True
  305 
  306 
  307 # -- Options for manual page output ---------------------------------------
  308 
  309 # One entry per manual page. List of tuples
  310 # (source start file, name, description, authors, manual section).
  311 man_pages = [
  312     (master_doc, 'xhtml2pdf', u'xhtml2pdf Documentation',
  313      [author], 1)
  314 ]
  315 
  316 # If true, show URL addresses after external links.
  317 #
  318 # man_show_urls = False
  319 
  320 
  321 # -- Options for Texinfo output -------------------------------------------
  322 
  323 # Grouping the document tree into Texinfo files. List of tuples
  324 # (source start file, target name, title, author,
  325 #  dir menu entry, description, category)
  326 texinfo_documents = [
  327     (master_doc, 'xhtml2pdf', u'xhtml2pdf Documentation',
  328      author, 'xhtml2pdf', 'One line description of project.',
  329      'Miscellaneous'),
  330 ]
  331 
  332 # Documents to append as an appendix to all manuals.
  333 #
  334 # texinfo_appendices = []
  335 
  336 # If false, no module index is generated.
  337 #
  338 # texinfo_domain_indices = True
  339 
  340 # How to display URL addresses: 'footnote', 'no', or 'inline'.
  341 #
  342 # texinfo_show_urls = 'footnote'
  343 
  344 # If true, do not generate a @detailmenu in the "Top" node's menu.
  345 #
  346 # texinfo_no_detailmenu = False
  347 
  348 
  349 # -- Options for Epub output ----------------------------------------------
  350 
  351 # Bibliographic Dublin Core info.
  352 epub_title = project
  353 epub_author = author
  354 epub_publisher = author
  355 epub_copyright = copyright
  356 
  357 # The basename for the epub file. It defaults to the project name.
  358 # epub_basename = project
  359 
  360 # The HTML theme for the epub output. Since the default themes are not
  361 # optimized for small screen space, using the same theme for HTML and epub
  362 # output is usually not wise. This defaults to 'epub', a theme designed to save
  363 # visual space.
  364 #
  365 # epub_theme = 'epub'
  366 
  367 # The language of the text. It defaults to the language option
  368 # or 'en' if the language is not set.
  369 #
  370 # epub_language = ''
  371 
  372 # The scheme of the identifier. Typical schemes are ISBN or URL.
  373 # epub_scheme = ''
  374 
  375 # The unique identifier of the text. This can be a ISBN number
  376 # or the project homepage.
  377 #
  378 # epub_identifier = ''
  379 
  380 # A unique identification for the text.
  381 #
  382 # epub_uid = ''
  383 
  384 # A tuple containing the cover image and cover page html template filenames.
  385 #
  386 # epub_cover = ()
  387 
  388 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
  389 #
  390 # epub_guide = ()
  391 
  392 # HTML files that should be inserted before the pages created by sphinx.
  393 # The format is a list of tuples containing the path and title.
  394 #
  395 # epub_pre_files = []
  396 
  397 # HTML files that should be inserted after the pages created by sphinx.
  398 # The format is a list of tuples containing the path and title.
  399 #
  400 # epub_post_files = []
  401 
  402 # A list of files that should not be packed into the epub file.
  403 epub_exclude_files = ['search.html']
  404 
  405 # The depth of the table of contents in toc.ncx.
  406 #
  407 # epub_tocdepth = 3
  408 
  409 # Allow duplicate toc entries.
  410 #
  411 # epub_tocdup = True
  412 
  413 # Choose between 'default' and 'includehidden'.
  414 #
  415 # epub_tocscope = 'default'
  416 
  417 # Fix unsupported image types using the Pillow.
  418 #
  419 # epub_fix_images = False
  420 
  421 # Scale large images.
  422 #
  423 # epub_max_image_width = 0
  424 
  425 # How to display URL addresses: 'footnote', 'no', or 'inline'.
  426 #
  427 # epub_show_urls = 'inline'
  428 
  429 # If false, no index is generated.
  430 #
  431 # epub_use_index = True
  432 
  433 
  434 # Example configuration for intersphinx: refer to the Python standard library.
  435 intersphinx_mapping = {'https://docs.python.org/': None}