docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Django documentation build configuration file, created by
   4 # sphinx-quickstart on Thu Mar 27 09:06:53 2008.
   5 #
   6 # This file is execfile()d with the current directory set to its containing dir.
   7 #
   8 # The contents of this file are pickled, so don't put values in the namespace
   9 # that aren't pickleable (module imports are okay, they're removed automatically).
  10 #
  11 # All configuration values have a default value; values that are commented out
  12 # serve to show the default value.
  13
  14 import sys
  15 import os
  16
  17 # If your extensions are in another directory, add it here.
  18 sys.path.append(os.path.join(os.path.dirname(__file__), "_ext"))
  19
  20 # General configuration
  21 # ---------------------
  22
  23 # Add any Sphinx extension module names here, as strings. They can be extensions
  24 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  25 extensions = ["djangodocs"]
  26
  27 # Add any paths that contain templates here, relative to this directory.
  28 templates_path = ["_templates"]
  29
  30 # The suffix of source filenames.
  31 source_suffix = '.txt'
  32
  33 # The master toctree document.
  34 master_doc = 'contents'
  35
  36 # General substitutions.
  37 project = 'Django'
  38 copyright = 'Django Software Foundation and contributors'
  39
  40 # The default replacements for |version| and |release|, also used in various
  41 # other places throughout the built documents.
  42 #
  43 # The short X.Y version.
  44 version = '1.0'
  45 # The full version, including alpha/beta/rc tags.
  46 release = version
  47
  48 # There are two options for replacing |today|: either, you set today to some
  49 # non-false value, then it is used:
  50 #today = ''
  51 # Else, today_fmt is used as the format for a strftime call.
  52 today_fmt = '%B %d, %Y'
  53
  54 # List of documents that shouldn't be included in the build.
  55 #unused_docs = []
  56
  57 # If true, '()' will be appended to :func: etc. cross-reference text.
  58 add_function_parentheses = True
  59
  60 # If true, the current module name will be prepended to all description
  61 # unit titles (such as .. function::).
  62 add_module_names = False
  63
  64 # If true, sectionauthor and moduleauthor directives will be shown in the
  65 # output. They are ignored by default.
  66 show_authors = False
  67
  68 # The name of the Pygments (syntax highlighting) style to use.
  69 pygments_style = 'trac'
  70
  71 # Options for HTML output
  72 # -----------------------
  73
  74 # The style sheet to use for HTML and HTML Help pages. A file of that name
  75 # must exist either in Sphinx' static/ path, or in one of the custom paths
  76 # given in html_static_path.
  77 html_style = 'default.css'
  78
  79 # Add any paths that contain custom static files (such as style sheets) here,
  80 # relative to this directory. They are copied after the builtin static files,
  81 # so a file named "default.css" will overwrite the builtin "default.css".
  82 html_static_path = ["_static"]
  83
  84 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  85 # using the given strftime format.
  86 html_last_updated_fmt = '%b %d, %Y'
  87
  88 # If true, SmartyPants will be used to convert quotes and dashes to
  89 # typographically correct entities.
  90 html_use_smartypants = True
  91
  92 # HTML translator class for the builder
  93 html_translator_class = "djangodocs.DjangoHTMLTranslator"
  94
  95 # Content template for the index page.
  96 #html_index = ''
  97
  98 # Custom sidebar templates, maps document names to template names.
  99 #html_sidebars = {}
 100
 101 # Additional templates that should be rendered to pages, maps page names to
 102 # template names.
 103 html_additional_pages = {}
 104
 105 # If false, no module index is generated.
 106 #html_use_modindex = True
 107
 108 # If true, the reST sources are included in the HTML build as _sources/<name>.
 109 html_copy_source = True
 110
 111 # Output file base name for HTML help builder.
 112 htmlhelp_basename = 'Djangodoc'
 113
 114
 115 # Options for LaTeX output
 116 # ------------------------
 117
 118 # The paper size ('letter' or 'a4').
 119 #latex_paper_size = 'letter'
 120
 121 # The font size ('10pt', '11pt' or '12pt').
 122 #latex_font_size = '10pt'
 123
 124 # Grouping the document tree into LaTeX files. List of tuples
 125 # (source start file, target name, title, author, document class [howto/manual]).
 126 #latex_documents = []
 127 latex_documents = [
 128   ('index', 'django.tex', 'Django Documentation', 'Django Software Foundation', 'manual'),
 129 ]
 130
 131 # Additional stuff for the LaTeX preamble.
 132 #latex_preamble = ''
 133
 134 # Documents to append as an appendix to all manuals.
 135 #latex_appendices = []
 136
 137 # If false, no module index is generated.
 138 #latex_use_modindex = True
 139
 140 # For "manual" documents, if this is true, then toplevel headings are parts,
 141 # not chapters.
 142 # If this isn't set to True, the LaTex writer can only handle six levels of headers.
 143 latex_use_parts = True
 144