openstack/training-guides
Code Issues Proposed changes

Merge "Improve the conf.py"

Browse Source
This commit is contained in:
Jenkins 2015-06-16 12:29:06 +00:00 committed by Gerrit Code Review
commit 8093bdf6d7
1 changed files with 38 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
doc/training-guides/associate-guide/conf.py
View File

@ -1,8 +1,16 @@
# -*- coding: utf-8 -*-
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# OpenStack Upstream Training documentation build configuration file, created by
# sphinx-quickstart on Sat Nov 1 14:32:31 2014.
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# This file is execfile()d with the current directory set to its
# containing dir.
#
@ -30,7 +38,6 @@ import os
# ones.
extensions = [
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.pngmath',
@ -38,7 +45,7 @@ extensions = [
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ['../_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@ -50,17 +57,17 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'OpenStack Training Guides'
copyright = u'2015, OpenStack'
project = u'Associate Training Guide'
copyright = u'2014-2015, OpenStack contributors'
# 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 = '2015.4'
version = '2015.5.01'
# The full version, including alpha/beta/rc tags.
release = '2015.4'
release = '2015.5.01'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -183,28 +190,28 @@ html_static_path = ['../_static']
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'OpenStackTrainingGuides-Associatedoc'
htmlhelp_basename = 'associate-training-guide'
# -- 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, or own class]).
latex_documents = [
('index', 'OpenStackTrainingGuides-Associate.tex', u'OpenStack Training Guides',
u'OpenStack', 'manual'),
('index', 'AssociateTrainingGuide.tex', u'Associate Training Guide',
u'OpenStack contributors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@ -232,10 +239,10 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
#man_pages = [
# ('index', 'openstackupstreamtraining', u'OpenStack Upstream Training Documentation',
# [u'Loic, Stefano and others'], 1)
#]
man_pages = [
('index', 'associate-training-guide', u'Associate Training Guide',
[u'OpenStack contributors'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
@ -246,11 +253,12 @@ latex_documents = [
# 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', 'OpenStackUpstreamTraining', u'OpenStack Upstream Training Documentation',
# u'Loic, Stefano and others', 'OpenStackUpstreamTraining', 'One line description of project.',
# 'Miscellaneous'),
#]
texinfo_documents = [
('index', 'AssociateTrainingGuide', u'Associate Training Guide',
u'OpenStack contributors', 'AssociateTrainingGuide',
'This guide is introduction to the OpenStack.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
@ -267,12 +275,9 @@ latex_documents = [
# -- Hieroglyph Slide Configuration ------------
extensions += [
'hieroglyph',
]
extensions += ['hieroglyph']
#slide_theme = 'slides'
#slide_theme = 'slides2'
slide_theme = 'single-level'
slide_levels = 3
slide_footer = ('<img alt="OS logo" src="_static/os_logo_small.png" '
@ -282,13 +287,6 @@ slide_footer = ('<img alt="OS logo" src="_static/os_logo_small.png" '
# the following lines to include them
slide_theme_options = {
'custom_css': 'custom.css',
}
'custom_css': 'custom.css',
}
#'custom_js': 'custom.js',
# ----------------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}