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