cookiecutter-django/{{cookiecutter.project_slug}}/docs/conf.py

248 lines
8.0 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
#
# {{ cookiecutter.project_name }} documentation build configuration file, created by
# sphinx-quickstart.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
2016-04-13 00:23:00 +03:00
from __future__ import unicode_literals
2014-10-30 15:39:49 +03:00
import os
import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
2014-10-30 15:39:49 +03:00
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
2014-10-30 15:39:49 +03:00
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
2014-10-30 15:39:49 +03:00
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
2016-04-13 00:23:00 +03:00
project = '{{ cookiecutter.project_name }}'
2016-06-05 03:16:48 +03:00
copyright = """{% now 'utc', '%Y' %}, {{ cookiecutter.author_name }}"""
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
2014-10-30 15:39:49 +03:00
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
2014-10-30 15:39:49 +03:00
# today = ''
# Else, today_fmt is used as the format for a strftime call.
2014-10-30 15:39:49 +03:00
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
2014-10-30 15:39:49 +03:00
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
2014-10-30 15:39:49 +03:00
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
2014-10-30 15:39:49 +03:00
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
2014-10-30 15:39:49 +03:00
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
2014-10-30 15:39:49 +03:00
# modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
2014-10-30 15:39:49 +03:00
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
2014-10-30 15:39:49 +03:00
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
2014-10-30 15:39:49 +03:00
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
2014-10-30 15:39:49 +03:00
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
2014-10-30 15:39:49 +03:00
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
2014-10-30 15:39:49 +03:00
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
2014-10-30 15:39:49 +03:00
# html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
2014-10-30 15:39:49 +03:00
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
2014-10-30 15:39:49 +03:00
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
2014-10-30 15:39:49 +03:00
# html_additional_pages = {}
# If false, no module index is generated.
2014-10-30 15:39:49 +03:00
# html_domain_indices = True
# If false, no index is generated.
2014-10-30 15:39:49 +03:00
# html_use_index = True
# If true, the index is split into individual pages for each letter.
2014-10-30 15:39:49 +03:00
# html_split_index = False
# If true, links to the reST sources are added to the pages.
2014-10-30 15:39:49 +03:00
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
2014-10-30 15:39:49 +03:00
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
2014-10-30 15:39:49 +03:00
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
2014-10-30 15:39:49 +03:00
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
2014-10-30 15:39:49 +03:00
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = '{{ cookiecutter.project_slug }}doc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
2014-10-30 15:39:49 +03:00
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
2014-10-30 15:39:49 +03:00
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
2014-10-30 15:39:49 +03:00
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
2014-10-30 15:39:49 +03:00
('index',
'{{ cookiecutter.project_slug }}.tex',
2016-04-13 00:23:00 +03:00
'{{ cookiecutter.project_name }} Documentation',
"""{{ cookiecutter.author_name }}""", 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
2014-10-30 15:39:49 +03:00
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
2014-10-30 15:39:49 +03:00
# latex_use_parts = False
# If true, show page references after internal links.
2014-10-30 15:39:49 +03:00
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
2014-10-30 15:39:49 +03:00
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
2014-10-30 15:39:49 +03:00
# latex_appendices = []
# If false, no module index is generated.
2014-10-30 15:39:49 +03:00
# latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', '{{ cookiecutter.project_slug }}', '{{ cookiecutter.project_name }} Documentation',
2016-04-13 00:23:00 +03:00
["""{{ cookiecutter.author_name }}"""], 1)
]
# If true, show URL addresses after external links.
2014-10-30 15:39:49 +03:00
# man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', '{{ cookiecutter.project_slug }}', '{{ cookiecutter.project_name }} Documentation',
2016-04-13 00:23:00 +03:00
"""{{ cookiecutter.author_name }}""", '{{ cookiecutter.project_name }}',
"""{{ cookiecutter.description }}""", 'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
2014-10-30 15:39:49 +03:00
# texinfo_appendices = []
# If false, no module index is generated.
2014-10-30 15:39:49 +03:00
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
2014-10-30 15:39:49 +03:00
# texinfo_show_urls = 'footnote'