conf.py 7 KB
Newer Older
Yannick Roehlly's avatar
Yannick Roehlly committed
1 2
# -*- coding: utf-8 -*-

3
# Adjust Python path to load the module
Médéric Boquien's avatar
Médéric Boquien committed
4 5
import os
import sys
Yannick Roehlly's avatar
Yannick Roehlly committed
6 7
sys.path.insert(0, os.path.abspath('..'))

8 9
# Use astropy Sphinx configuration
from astropy.sphinx.conf import *
Yannick Roehlly's avatar
Yannick Roehlly committed
10

11
# -- General configuration ----------------------------------------------------
Yannick Roehlly's avatar
Yannick Roehlly committed
12

13 14
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.1'
Yannick Roehlly's avatar
Yannick Roehlly committed
15

16 17 18
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns.append('_templates')
Yannick Roehlly's avatar
Yannick Roehlly committed
19

20 21 22 23
# This is added to the end of RST files - a good place to put substitutions to
# be used globally.
rst_epilog += """
"""
Yannick Roehlly's avatar
Yannick Roehlly committed
24

25
# -- Project information ----------------------------------------------------
Yannick Roehlly's avatar
Yannick Roehlly committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39
project = u'pcigale'
author = u'The pcigale team'
copyright = u'2013, Laboratoire d\'Astrophysique de Marseille'

# 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.

import pcigale
# The short X.Y version.
version = pcigale.__version__.split('-', 1)[0]
# The full version, including alpha/beta/rc tags.
release = pcigale.__version__

Médéric Boquien's avatar
Médéric Boquien committed
40
# -- Options for HTML output --------------------------------------------------
Yannick Roehlly's avatar
Yannick Roehlly committed
41

42 43 44 45 46 47
# A NOTE ON HTML THEMES
# The global astropy configuration uses a custom theme, 'bootstrap-astropy',
# which is installed along with astropy. A different theme can be used or
# the options for this theme can be modified by overriding some of the
# variables set in the global configuration. The variables set in the
# global configuration are listed below, commented out.
Yannick Roehlly's avatar
Yannick Roehlly committed
48 49

# Add any paths that contain custom themes here, relative to this directory.
50
# To use a different custom theme, add the directory containing the theme.
Yannick Roehlly's avatar
Yannick Roehlly committed
51 52
#html_theme_path = []

53 54 55 56
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. To override the custom theme, set this to the
# name of a builtin theme or the name of a custom theme in html_theme_path.
#html_theme = None
Yannick Roehlly's avatar
Yannick Roehlly committed
57

58 59
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
Yannick Roehlly's avatar
Yannick Roehlly committed
60 61

# The name of an image file (within the static path) to use as favicon of the
62
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Yannick Roehlly's avatar
Yannick Roehlly committed
63
# pixels large.
64
#html_favicon = ''
Yannick Roehlly's avatar
Yannick Roehlly committed
65 66 67

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
68
#html_last_updated_fmt = ''
Yannick Roehlly's avatar
Yannick Roehlly committed
69

70 71 72
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = '{0} v{1}'.format(project, release)
Yannick Roehlly's avatar
Yannick Roehlly committed
73 74

# Output file base name for HTML help builder.
75
htmlhelp_basename = project + 'doc'
Yannick Roehlly's avatar
Yannick Roehlly committed
76 77


Médéric Boquien's avatar
Médéric Boquien committed
78
# -- Options for LaTeX output -------------------------------------------------
Yannick Roehlly's avatar
Yannick Roehlly committed
79 80

latex_elements = {
81 82
    # The paper size ('letterpaper' or 'a4paper').
    #'papersize': 'letterpaper',
Yannick Roehlly's avatar
Yannick Roehlly committed
83

84 85
    # The font size ('10pt', '11pt' or '12pt').
    #'pointsize': '10pt',
Yannick Roehlly's avatar
Yannick Roehlly committed
86

87 88
    # Additional stuff for the LaTeX preamble.
    #'preamble': '',
Yannick Roehlly's avatar
Yannick Roehlly committed
89 90 91
}

# Grouping the document tree into LaTeX files. List of tuples
Médéric Boquien's avatar
Médéric Boquien committed
92 93
# (source start file, target name, title, author, documentclass
# [howto/manual]).
Yannick Roehlly's avatar
Yannick Roehlly committed
94
latex_documents = [
95 96 97
    ('index', 'pcigale.tex', u'pcigale Documentation',
     u'pcigale team', 'manual'),
    ]
Yannick Roehlly's avatar
Yannick Roehlly committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


Médéric Boquien's avatar
Médéric Boquien committed
120
# -- Options for manual page output -------------------------------------------
Yannick Roehlly's avatar
Yannick Roehlly committed
121 122 123 124 125 126 127 128 129 130 131 132

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'pcigale', u'pcigale Documentation',
     [u'pcigale team'], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


Médéric Boquien's avatar
Médéric Boquien committed
133
# -- Options for Texinfo output -----------------------------------------------
Yannick Roehlly's avatar
Yannick Roehlly committed
134 135 136 137 138

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
139 140 141 142
    ('index', 'pcigale', u'pcigale Documentation',
     u'pcigale team', 'pcigale', 'One line description of project.',
     'Miscellaneous'),
    ]
Yannick Roehlly's avatar
Yannick Roehlly committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False


Médéric Boquien's avatar
Médéric Boquien committed
157
# -- Options for Epub output --------------------------------------------------
Yannick Roehlly's avatar
Yannick Roehlly committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

# Bibliographic Dublin Core info.
epub_title = u'pcigale documentation'
epub_author = u'pcigale team'
epub_publisher = u'Laboratoire d\'Astrophysique de Marseille'
epub_copyright = u'Laboratoire d\'Astrophysique de Marseille'

# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''

# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''

# A unique identification for the text.
#epub_uid = ''

# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()

# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()

# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []

# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []

# A list of files that should not be packed into the epub file.
#epub_exclude_files = []

# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3

# Allow duplicate toc entries.
#epub_tocdup = True

# Fix unsupported image types using the PIL.
#epub_fix_images = False

# Scale large images.
#epub_max_image_width = 0

# If 'no', URL addresses will not be shown.
#epub_show_urls = 'inline'

# If false, no index is generated.
#epub_use_index = True
213

Médéric Boquien's avatar
Médéric Boquien committed
214
## -- Options for the edit_on_github extension --------------------------------
215 216 217 218 219 220 221 222 223 224 225 226 227 228
#
#extensions += ['astropy.sphinx.ext.edit_on_github']
#
## Don't import the module as "version" or it will override the
## "version" configuration parameter
#from packagename import version as versionmod
#edit_on_github_project = "astropy/reponame"
#if versionmod.release:
# edit_on_github_branch = "v" + versionmod.version
#else:
# edit_on_github_branch = "master"
#
#edit_on_github_source_root = ""
#edit_on_github_doc_root = "docs"