Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
cigale
CIGALE
Commits
4f38a1ce
Commit
4f38a1ce
authored
Sep 15, 2013
by
Yannick Roehlly
Browse files
Use astropy theme for documentation
parent
85451622
Changes
1
Hide whitespace changes
Inline
Side-by-side
docs/conf.py
View file @
4f38a1ce
# -*- coding: utf-8 -*-
#
# pcigale documentation build configuration file, created by
# sphinx-quickstart on Wed Sep 11 16:32:56 2013.
#
# 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.
# Adjust Python path to load the module
import
sys
,
os
# 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.
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
'..'
))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#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
=
[
'sphinx.ext.autodoc'
,
'sphinx.ext.todo'
,
'sphinx.ext.mathjax'
]
# Add todos to the documentation
todo_include_todos
=
True
# Use astropy Sphinx configuration
from
astropy.sphinx.conf
import
*
# Add any paths that contain templates here, relative to this directory.
templates_path
=
[
'_templates'
]
exclude_trees
=
[
'_templates'
]
# -- General configuration ----------------------------------------------------
#
The suffix of source filenames
.
source_suffi
x
=
'
.rst
'
#
If your documentation needs a minimal Sphinx version, state it here
.
#needs_sphin
x = '
1.1
'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns
.
append
(
'_templates'
)
# The master toctree document.
master_doc
=
'index'
# This is added to the end of RST files - a good place to put substitutions to
# be used globally.
rst_epilog
+=
"""
"""
#
General
information
about the project.
#
-- Project
information
----------------------------------------------------
project
=
u
'pcigale'
author
=
u
'The pcigale team'
copyright
=
u
'2013, Laboratoire d
\'
Astrophysique de Marseille'
...
...
@@ -58,143 +36,63 @@ version = pcigale.__version__.split('-', 1)[0]
# The full version, including alpha/beta/rc tags.
release
=
pcigale
.
__version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#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.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#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.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- 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
=
'sphinxdoc'
# 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.
#html_theme_options = {}
# 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.
# Add any paths that contain custom themes here, relative to this directory.
# To use a different custom theme, add the directory containing the theme.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# 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
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# 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
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#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'
]
#html_favicon = ''
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
#html_last_updated_fmt = ''
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#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.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# 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
)
# Output file base name for HTML help builder.
htmlhelp_basename
=
'pcigale
doc'
htmlhelp_basename
=
project
+
'
doc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements
=
{
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# 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
=
[
(
'index'
,
'pcigale.tex'
,
u
'pcigale Documentation'
,
u
'pcigale team'
,
'manual'
),
]
(
'index'
,
'pcigale.tex'
,
u
'pcigale Documentation'
,
u
'pcigale team'
,
'manual'
),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
...
...
@@ -236,10 +134,10 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents
=
[
(
'index'
,
'pcigale'
,
u
'pcigale Documentation'
,
u
'pcigale team'
,
'pcigale'
,
'One line description of project.'
,
'Miscellaneous'
),
]
(
'index'
,
'pcigale'
,
u
'pcigale Documentation'
,
u
'pcigale team'
,
'pcigale'
,
'One line description of project.'
,
'Miscellaneous'
),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
...
...
@@ -310,3 +208,20 @@ epub_copyright = u'Laboratoire d\'Astrophysique de Marseille'
# If false, no index is generated.
#epub_use_index = True
## -- Options for the edit_on_github extension ----------------------------------------
#
#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"
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment