docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # ppu documentation build configuration file, created by
   4 # sphinx-quickstart on Sat Apr 15 20:37:34 2017.
   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
  24 # -- General configuration ------------------------------------------------
  25
  26 # If your documentation needs a minimal Sphinx version, state it here.
  27 #
  28 # needs_sphinx = '1.0'
  29
  30 # Add any Sphinx extension module names here, as strings. They can be
  31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  32 # ones.
  33 extensions = ['sphinx.ext.autodoc']
  34
  35 # Add any paths that contain templates here, relative to this directory.
  36 templates_path = ['_templates']
  37
  38 # The suffix(es) of source filenames.
  39 # You can specify multiple suffix as a list of string:
  40 #
  41 # source_suffix = ['.rst', '.md']
  42 source_suffix = '.rst'
  43
  44 # The master toctree document.
  45 master_doc = 'index'
  46
  47 # General information about the project.
  48 project = 'Portable Python Utilities'
  49 copyright = '2017, Oleg Broytman'
  50 author = 'Oleg Broytman'
  51
  52 # The version info for the project you're documenting, acts as replacement for
  53 # |version| and |release|, also used in various other places throughout the
  54 # built documents.
  55 #
  56 # The short X.Y version.
  57 version = '0.1'
  58 # The full version, including alpha/beta/rc tags.
  59 release = '0.1.0'
  60
  61 # The language for content autogenerated by Sphinx. Refer to documentation
  62 # for a list of supported languages.
  63 #
  64 # This is also used if you do content translation via gettext catalogs.
  65 # Usually you set "language" from the command line for these cases.
  66 language = None
  67
  68 # List of patterns, relative to source directory, that match files and
  69 # directories to ignore when looking for source files.
  70 # This patterns also effect to html_static_path and html_extra_path
  71 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  72
  73 # The name of the Pygments (syntax highlighting) style to use.
  74 pygments_style = 'sphinx'
  75
  76 # If true, `todo` and `todoList` produce output, else they produce nothing.
  77 todo_include_todos = False
  78
  79
  80 # -- Options for HTML output ----------------------------------------------
  81
  82 # The theme to use for HTML and HTML Help pages.  See the documentation for
  83 # a list of builtin themes.
  84 #
  85 html_theme = 'alabaster'
  86
  87 # Theme options are theme-specific and customize the look and feel of a theme
  88 # further.  For a list of options available for each theme, see the
  89 # documentation.
  90 #
  91 # html_theme_options = {}
  92
  93 # Add any paths that contain custom static files (such as style sheets) here,
  94 # relative to this directory. They are copied after the builtin static files,
  95 # so a file named "default.css" will overwrite the builtin "default.css".
  96 html_static_path = ['_static']
  97
  98
  99 # -- Options for HTMLHelp output ------------------------------------------
 100
 101 # Output file base name for HTML help builder.
 102 htmlhelp_basename = 'ppudoc'
 103
 104
 105 # -- Options for LaTeX output ---------------------------------------------
 106
 107 latex_elements = {
 108     # The paper size ('letterpaper' or 'a4paper').
 109     #
 110     # 'papersize': 'letterpaper',
 111
 112     # The font size ('10pt', '11pt' or '12pt').
 113     #
 114     # 'pointsize': '10pt',
 115
 116     # Additional stuff for the LaTeX preamble.
 117     #
 118     # 'preamble': '',
 119
 120     # Latex figure (float) alignment
 121     #
 122     # 'figure_align': 'htbp',
 123 }
 124
 125 # Grouping the document tree into LaTeX files. List of tuples
 126 # (source start file, target name, title,
 127 #  author, documentclass [howto, manual, or own class]).
 128 latex_documents = [
 129     (master_doc, 'ppu.tex', 'Portable Python Utilities Documentation',
 130      'Oleg Broytman', 'manual'),
 131 ]
 132
 133
 134 # -- Options for manual page output ---------------------------------------
 135
 136 # One entry per manual page. List of tuples
 137 # (source start file, name, description, authors, manual section).
 138 man_pages = [
 139     (master_doc, 'ppu', 'Portable Python Utilities Documentation',
 140      [author], 1)
 141 ]
 142
 143
 144 # -- Options for Texinfo output -------------------------------------------
 145
 146 # Grouping the document tree into Texinfo files. List of tuples
 147 # (source start file, target name, title, author,
 148 #  dir menu entry, description, category)
 149 texinfo_documents = [
 150     (master_doc, 'ppu', 'Portable Python Utilities Documentation',
 151      author, 'ppu', 'Portable Python Utilities.',
 152      'Miscellaneous'),
 153 ]