policy/conf.py.in

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3 #
   4 # Debian Policy Manual documentation build configuration file, created by
   5 # sphinx-quickstart on Tue Aug  8 07:14:47 2017.
   6 #
   7 # This file is execfile()d with the current directory set to its
   8 # containing dir.
   9 #
  10 # Note that not all possible configuration values are present in this
  11 # autogenerated file.
  12 #
  13 # All configuration values have a default; values that are commented out
  14 # serve to show the default.
  15
  16 # If extensions (or modules to document with autodoc) are in another directory,
  17 # add these directories to sys.path here. If the directory is relative to the
  18 # documentation root, use os.path.abspath to make it absolute, like shown here.
  19 #
  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 = []
  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 = 'Debian Policy Manual'
  50 copyright = '1996, 1997, 1998 Ian Jackson, Christian Schwarz, 1998-2017, The Debian Policy Mailing List'
  51 author = 'The Debian Policy Mailing List'
  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 # The short X.Y version.
  58 version = '@VERSION@'
  59 # The full version, including alpha/beta/rc tags.
  60 release = '@VERSION@'
  61
  62 # The language for content autogenerated by Sphinx. Refer to documentation
  63 # for a list of supported languages.
  64 #
  65 # This is also used if you do content translation via gettext catalogs.
  66 # Usually you set "language" from the command line for these cases.
  67 language = None
  68
  69 # List of patterns, relative to source directory, that match files and
  70 # directories to ignore when looking for source files.
  71 # This patterns also effect to html_static_path and html_extra_path
  72 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  73
  74 # The name of the Pygments (syntax highlighting) style to use.
  75 pygments_style = 'sphinx'
  76
  77 # If true, `todo` and `todoList` produce output, else they produce nothing.
  78 todo_include_todos = False
  79
  80
  81 # -- Options for HTML output ----------------------------------------------
  82
  83 # The theme to use for HTML and HTML Help pages.  See the documentation for
  84 # a list of builtin themes.
  85 #
  86 html_theme = 'nature'
  87
  88 # Theme options are theme-specific and customize the look and feel of a theme
  89 # further.  For a list of options available for each theme, see the
  90 # documentation.
  91 #
  92 # html_theme_options = {}
  93
  94 # Override the title to remove the unnecessary "documentation" suffix.
  95 html_title = "Debian Policy Manual v@VERSION@"
  96
  97 # Suppress the copyright notice.
  98 html_show_copyright = False
  99
 100 # Add any paths that contain custom static files (such as style sheets) here,
 101 # relative to this directory. They are copied after the builtin static files,
 102 # so a file named "default.css" will overwrite the builtin "default.css".
 103 #
 104 # html_static_path = ['_static']
 105
 106
 107 # -- Options for HTMLHelp output ------------------------------------------
 108
 109 # Output file base name for HTML help builder.
 110 htmlhelp_basename = 'policy'
 111
 112
 113 # -- Options for LaTeX output ---------------------------------------------
 114
 115 latex_elements = {
 116     # The paper size ('letterpaper' or 'a4paper').
 117     #
 118     # 'papersize': 'letterpaper',
 119
 120     # The font size ('10pt', '11pt' or '12pt').
 121     #
 122     # 'pointsize': '10pt',
 123
 124     # Additional stuff for the LaTeX preamble.
 125     #
 126     # 'preamble': '',
 127
 128     # Latex figure (float) alignment
 129     #
 130     # 'figure_align': 'htbp',
 131 }
 132
 133 # Grouping the document tree into LaTeX files. List of tuples
 134 # (source start file, target name, title,
 135 #  author, documentclass [howto, manual, or own class]).
 136 latex_documents = [
 137     (master_doc, 'policy.tex', 'Debian Policy Manual',
 138      'The Debian Policy Mailing List', 'manual'),
 139 ]
 140
 141
 142 # -- Options for manual page output ---------------------------------------
 143
 144 # One entry per manual page. List of tuples
 145 # (source start file, name, description, authors, manual section).
 146 man_pages = [
 147     (master_doc, 'policy', 'Debian Policy Manual',
 148      [author], 1)
 149 ]
 150
 151
 152 # -- Options for Texinfo output -------------------------------------------
 153
 154 # Grouping the document tree into Texinfo files. List of tuples
 155 # (source start file, target name, title, author,
 156 #  dir menu entry, description, category)
 157 texinfo_documents = [
 158     (master_doc, 'debian-policy', 'Debian Policy Manual',
 159      author, 'debian-policy', 'Debian Policy Manual.',
 160      'Miscellaneous'),
 161 ]
 162
 163
 164
 165 # -- Options for Epub output ----------------------------------------------
 166
 167 # Use a simpler file name.
 168 epub_basename = 'policy'
 169
 170 # Bibliographic Dublin Core info.
 171 epub_title = project
 172 epub_author = author
 173 epub_publisher = author
 174 epub_copyright = copyright
 175 epub_description = """
 176 This manual describes the policy requirements for the Debian distribution.
 177 This includes the structure and contents of the Debian archive and several
 178 design issues of the operating system, as well as technical requirements
 179 that each package must satisfy to be included in the distribution.
 180 """
 181
 182 # The unique identifier of the text. This can be an ISBN number
 183 # or the project homepage.
 184 #
 185 # epub_identifier = ''
 186
 187 # A unique identification for the text.
 188 #
 189 # epub_uid = ''
 190
 191 # A list of files that should not be packed into the epub file.
 192 epub_exclude_files = ['search.html']