openstack/training-guides
Code Issues Proposed changes

Merge "[upstream-training] improve the conf.py file"

Browse Source
This commit is contained in:
Jenkins
2015-05-28 13:33:24 +00:00
committed by Gerrit Code Review
parent a920424dec 65c558e294
commit ce1d1e673f
1 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
doc/upstream-training/source/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 # http://www.apache.org/licenses/LICENSE-2.0
# sphinx-quickstart on Sat Nov 1 14:32:31 2014.
# #
# 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 # This file is execfile()d with the current directory set to its
# containing dir. # containing dir.
# #
@@ -30,7 +38,6 @@ import os
# ones. # ones.
extensions = [ extensions = [
'sphinx.ext.doctest', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'sphinx.ext.pngmath', 'sphinx.ext.pngmath',
@@ -50,8 +57,8 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'OpenStack Upstream Training' project = u'Upstream Training Guide'
copyright = u'2014, Loic, Stefano and others' copyright = u'2014-2015, OpenStack contributors'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@@ -183,28 +190,28 @@ html_static_path = ['_static']
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'OpenStackUpstreamTrainingdoc' htmlhelp_basename = 'upstream-training-guide'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper', #'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt'). # The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt', #'pointsize': '10pt',
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
#'preamble': '', #'preamble': '',
} }
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', 'OpenStackUpstreamTraining.tex', u'OpenStack Upstream Training Documentation', ('index', 'UpstreamTrainingGuide.tex', u'Upstream Training Guide',
u'Loic, Stefano and others', 'manual'), u'OpenStack contributors', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # 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 # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
#man_pages = [ man_pages = [
# ('index', 'openstackupstreamtraining', u'OpenStack Upstream Training Documentation', ('index', 'upstream-training-guide', u'Upstream Training Guide',
# [u'Loic, Stefano and others'], 1) [u'OpenStack contributors'], 1)
#] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#man_show_urls = False #man_show_urls = False
@@ -246,11 +253,12 @@ latex_documents = [
# Grouping the document tree into Texinfo files. List of tuples # Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
#texinfo_documents = [ texinfo_documents = [
# ('index', 'OpenStackUpstreamTraining', u'OpenStack Upstream Training Documentation', ('index', 'UpstreamTrainingGuide', u'Upstream Training Guide',
# u'Loic, Stefano and others', 'OpenStackUpstreamTraining', 'One line description of project.', u'OpenStack contributors', 'UpstreamTrainingGuide',
# 'Miscellaneous'), 'This guide shows how to work with the OpenStack upstream.',
#] 'Miscellaneous'),
]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
#texinfo_appendices = [] #texinfo_appendices = []
@@ -267,26 +275,18 @@ latex_documents = [
# -- Hieroglyph Slide Configuration ------------ # -- Hieroglyph Slide Configuration ------------
extensions += [ extensions += ['hieroglyph']
'hieroglyph',
]
#slide_theme = 'slides' #slide_theme = 'slides'
slide_theme = 'single-level' slide_theme = 'single-level'
slide_levels = 3 slide_levels = 3
slide_footer = '<img alt="OS logo" src="_static/os_logo_small.png" style="width: 4em;">' slide_footer = ('<img alt="OS logo" src="_static/os_logo_small.png" '
'style="width: 4em;">')
# Place custom static assets in the _static directory and uncomment # Place custom static assets in the _static directory and uncomment
# the following lines to include them # the following lines to include them
slide_theme_options = { slide_theme_options = {
'custom_css': 'custom.css', 'custom_css': 'custom.css',
} }
#'custom_js': 'custom.js', #'custom_js': 'custom.js',
# ----------------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}