docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # dulwich documentation build configuration file, created by
   4 # sphinx-quickstart on Thu Feb 18 23:18:28 2010.
   5 #
   6 # This file is execfile()d with the current directory set to its containing
   7 # 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 import os
  16 import sys
  17
  18 # If extensions (or modules to document with autodoc) are in another directory,
  19 # add these directories to sys.path here. If the directory is relative to the
  20 # documentation root, use os.path.abspath to make it absolute, like shown here.
  21 sys.path.insert(0, os.path.abspath('..'))
  22 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__))))
  23 dulwich = __import__('dulwich')
  24
  25 # -- General configuration ----------------------------------------------------
  26
  27 # Add any Sphinx extension module names here, as strings. They can be
  28 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  29 extensions = ['sphinx.ext.autodoc']
  30 try:
  31     import rst2pdf
  32     if rst2pdf.version >= '0.16':
  33         extensions.append('rst2pdf.pdfbuilder')
  34 except ImportError:
  35     print("[NOTE] In order to build PDF you need rst2pdf with version >=0.16")
  36
  37
  38 autoclass_content = "both"
  39
  40 # Add any paths that contain templates here, relative to this directory.
  41 templates_path = ['templates']
  42
  43 # The suffix of source filenames.
  44 source_suffix = '.txt'
  45
  46 # The encoding of source files.
  47 #         source_encoding = 'utf-8'
  48
  49 # The master toctree document.
  50 master_doc = 'index'
  51
  52 # General information about the project.
  53 project = u'dulwich'
  54 copyright = u'2011, Jelmer Vernooij'
  55
  56 # The version info for the project you're documenting, acts as replacement for
  57 # |version| and |release|, also used in various other places throughout the
  58 # built documents.
  59 #
  60 # The short X.Y version.
  61 version = '.'.join(map(str, dulwich.__version__[:2]))
  62 # The full version, including alpha/beta/rc tags.
  63 release = '.'.join(map(str, dulwich.__version__))
  64
  65 # The language for content autogenerated by Sphinx. Refer to documentation
  66 # for a list of supported languages.
  67 # language = None
  68
  69 # There are two options for replacing |today|: either, you set today to some
  70 # non-false value, then it is used:
  71 # today = ''
  72 # Else, today_fmt is used as the format for a strftime call.
  73 # today_fmt = '%B %d, %Y'
  74
  75 # List of documents that shouldn't be included in the build.
  76 # unused_docs = []
  77
  78 # List of directories, relative to source directory, that shouldn't be searched
  79 # for source files.
  80 exclude_trees = ['build']
  81
  82 # The reST default role (used for this markup: `text`) to use for all
  83 # documents.
  84 # default_role = None
  85
  86 # If true, '()' will be appended to :func: etc. cross-reference text.
  87 # add_function_parentheses = True
  88
  89 # If true, the current module name will be prepended to all description
  90 # unit titles (such as .. function::).
  91 # add_module_names = True
  92
  93 # If true, sectionauthor and moduleauthor directives will be shown in the
  94 # output. They are ignored by default.
  95 # show_authors = False
  96
  97 # The name of the Pygments (syntax highlighting) style to use.
  98 pygments_style = 'sphinx'
  99
 100 # A list of ignored prefixes for module index sorting.
 101 # modindex_common_prefix = []
 102
 103
 104 # -- Options for HTML output -------------------------------------------------
 105
 106 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 107 # Sphinx are currently 'default' and 'sphinxdoc'.
 108 # html_theme = 'default'
 109 html_theme = 'nature'
 110
 111 # Theme options are theme-specific and customize the look and feel of a theme
 112 # further.  For a list of options available for each theme, see the
 113 # documentation.
 114 # html_theme_options = {}
 115
 116 # Add any paths that contain custom themes here, relative to this directory.
 117 html_theme_path = ['theme']
 118
 119 # The name for this set of Sphinx documents.  If None, it defaults to
 120 # "<project> v<release> documentation".
 121 # html_title = None
 122
 123 # A shorter title for the navigation bar.  Default is the same as html_title.
 124 # html_short_title = None
 125
 126 # The name of an image file (relative to this directory) to place at the top
 127 # of the sidebar.
 128 # html_logo = None
 129
 130 # The name of an image file (within the static path) to use as favicon of the
 131 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 132 # pixels large.
 133 # html_favicon = None
 134
 135 # Add any paths that contain custom static files (such as style sheets) here,
 136 # relative to this directory. They are copied after the builtin static files,
 137 # so a file named "default.css" will overwrite the builtin "default.css".
 138 html_static_path = []
 139
 140 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 141 # using the given strftime format.
 142 # html_last_updated_fmt = '%b %d, %Y'
 143
 144 # If true, SmartyPants will be used to convert quotes and dashes to
 145 # typographically correct entities.
 146 # html_use_smartypants = True
 147
 148 # Custom sidebar templates, maps document names to template names.
 149 # html_sidebars = {}
 150
 151 # Additional templates that should be rendered to pages, maps page names to
 152 # template names.
 153 # html_additional_pages = {}
 154
 155 # If false, no module index is generated.
 156 # html_use_modindex = True
 157
 158 # If false, no index is generated.
 159 # html_use_index = True
 160
 161 # If true, the index is split into individual pages for each letter.
 162 # html_split_index = False
 163
 164 # If true, links to the reST sources are added to the pages.
 165 # html_show_sourcelink = True
 166
 167 # If true, an OpenSearch description file will be output, and all pages will
 168 # contain a <link> tag referring to it.  The value of this option must be the
 169 # base URL from which the finished HTML is served.
 170 # html_use_opensearch = ''
 171
 172 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 173 # html_file_suffix = ''
 174
 175 # Output file base name for HTML help builder.
 176 htmlhelp_basename = 'dulwichdoc'
 177
 178
 179 # -- Options for LaTeX output ------------------------------------------------
 180
 181 # The paper size ('letter' or 'a4').
 182 # latex_paper_size = 'letter'
 183
 184 # The font size ('10pt', '11pt' or '12pt').
 185 # latex_font_size = '10pt'
 186
 187 # Grouping the document tree into LaTeX files. List of tuples
 188 # (source start file, target name, title, author, documentclass
 189 # [howto/manual]).
 190 latex_documents = [
 191   ('index', 'dulwich.tex', u'dulwich Documentation',
 192    u'Jelmer Vernooij', 'manual'),
 193 ]
 194
 195 # The name of an image file (relative to this directory) to place at the top of
 196 # the title page.
 197 # latex_logo = None
 198
 199 # For "manual" documents, if this is true, then toplevel headings are parts,
 200 # not chapters.
 201 # latex_use_parts = False
 202
 203 # Additional stuff for the LaTeX preamble.
 204 # latex_preamble = ''
 205
 206 # Documents to append as an appendix to all manuals.
 207 # latex_appendices = []
 208
 209 # If false, no module index is generated.
 210 # latex_use_modindex = True
 211
 212 pdf_documents = [
 213     ('index', u'dulwich', u'Documentation for dulwich',
 214         u'Jelmer Vernooij'),
 215 ]
 216 pdf_stylesheets = ['sphinx', 'kerning', 'a4']
 217 pdf_break_level = 2
 218 pdf_inline_footnotes = True