Added RelNotes PDF generation
This commit is contained in:
Pavel Lechenko
parent
297652712c
commit
ad3778db70
9
Makefile
9
Makefile
|
|
@ -124,9 +124,12 @@ latex: images
|
|||
pdf: images
|
||||
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/pdf."
|
||||
@echo "Run \`make' in that directory to run these through pdf" \
|
||||
"(use \`make pdf' here to do that automatically)."
|
||||
@echo "Build finished; the PDF file is in $(BUILDDIR)/pdf."
|
||||
|
||||
rnpdf: images
|
||||
$(SPHINXBUILD) -b pdf -c relnotes $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
|
||||
@echo
|
||||
@echo "Build finished; the PDF file is in $(BUILDDIR)/pdf."
|
||||
|
||||
latexpdf: images
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
|
|
|
|||
2
conf.py
2
conf.py
|
|
@ -75,7 +75,7 @@ release = '3.1'
|
|||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_*', "pages", 'rn_index.rst']
|
||||
exclude_patterns = ['_*', "pages", 'relnotes']
|
||||
# exclude_patterns = ['_*', 'rn_index.rst']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,92 @@
|
|||
=======================================
|
||||
Fuel™ 3.1 for OpenStack - Release Notes
|
||||
=======================================
|
||||
|
||||
Mirantis, Inc. is releasing version 3.1 of Fuel™ - which is now a single product
|
||||
that combines both the Fuel Library and Fuel Web products previously offered by
|
||||
Mirantis. These Release Notes supplement the product documentation and list
|
||||
enhancements, resolved issues and known issues in this version.
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 1
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
What Is Fuel™?
|
||||
==============
|
||||
|
||||
Fuel™ is the ultimate OpenStack Do-it-Yourself Kit. Purpose built to assimilate
|
||||
the hard-won experience of our services team, it contains the tooling,
|
||||
information, and support you need to accelerate time to production with
|
||||
OpenStack cloud. Fuel is designed to work with Puppet configuration management
|
||||
software, using Cobbler for bare metal provisioning.
|
||||
|
||||
Fuel automates provisioning and deployment of all core OpenStack components
|
||||
including Nova, Glance, Horizon, Swift, Keystone, Neutron (formerly Quantum)
|
||||
and Cinder, as well as key open source packages for components required to
|
||||
support High Availability deployment configurations, such as Galera, Pacemaker,
|
||||
Corosync, and HAProxy.
|
||||
|
||||
To help make the most of your time and resources, and to help tame the risk
|
||||
and complexity of managing dynamic OpenStack environments, Fuel features a
|
||||
streamlined, graphical console. Its intuitive interface controls deployment
|
||||
and provisioning of your OpenStack cloud, providing a point-and-click
|
||||
experience for the most commonly deployed configurations. If you are familiar
|
||||
with tools like Cobbler and Puppet and want maximum flexibility in your
|
||||
deployment, the command-line capabilities of the Fuel Library can also be used
|
||||
for automated deployment and configuration of your OpenStack infrastructure.
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
.. include:: /pages/release-notes/v3-1-grizzly.rst
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
How To Obtain The Product
|
||||
=========================
|
||||
|
||||
Fuel is distributed as a self-contained ISO that, once downloaded, does not
|
||||
require Internet access to provision OpenStack nodes. This ISO is available in
|
||||
the Fuel Download http://fuel.mirantis.com/your-downloads/ section of the
|
||||
Fuel Portal http://fuel.mirantis.com/
|
||||
|
||||
Here you will also find the Oracle VirtualBox scripts to enable quick and easy
|
||||
deployment of a multi-node OpenStack cloud for evaluation purposes. Note that
|
||||
you will need to be subscribed to the Mirantis site to access the downloads.
|
||||
|
||||
Subscription is free of charge.
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
Contacting Support
|
||||
==================
|
||||
|
||||
You can contact support online, through E-mail or via phone. Instructions on
|
||||
how to use any of these contact options can be found on the
|
||||
Support Home Page at https://mirantis.zendesk.com/home
|
||||
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
Spacer 0 200
|
||||
|
||||
.. image:: /_static/mirantis_logo.png
|
||||
:align: left
|
||||
|
||||
**To learn more about how Mirantis can help your business, please visit**
|
||||
http://www.mirantis.com/
|
||||
|
||||
Mirantis, Fuel, the Mirantis logos and other Mirantis marks are trademarks or
|
||||
registered trademarks of Mirantis, Inc. in the U.S. and/or certain other
|
||||
countries. Red Hat Enterprise Linux is a registered trademark of Red Hat, Inc.
|
||||
Ubuntu is a registered trademark of Canonical Ltd. VirtualBox is a registered
|
||||
trademark of Oracle Corporation. All other registered trademarks or trademarks
|
||||
belong to their respective companies.
|
||||
|
|
@ -0,0 +1,353 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# "Fuel" documentation build configuration file, created by
|
||||
# sphinx-quickstart on Tue Sep 25 14:02:29 2012.
|
||||
#
|
||||
# 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.
|
||||
|
||||
import sys, os
|
||||
import cloud_sptheme as csp
|
||||
|
||||
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||||
|
||||
# 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.
|
||||
#if on_rtd:
|
||||
# extensions = ['sphinx.ext.autodoc','sphinxcontrib.plantuml']
|
||||
# display_github = False
|
||||
#else:
|
||||
extensions = ['sphinx.ext.autodoc','rst2pdf.pdfbuilder','sphinxcontrib.plantuml']
|
||||
#,'sphinxcontrib.fancybox']
|
||||
|
||||
plantuml = ['java','-jar','/sbin/plantuml.jar']
|
||||
|
||||
# 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.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'contents'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Fuel for OpenStack'
|
||||
copyright = u'2013, Mirantis Inc.'
|
||||
|
||||
# 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 = '3.1'
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '3.1'
|
||||
|
||||
# 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 = ['_*', "pages"]
|
||||
# exclude_patterns = ['_*', 'rn_index.rst']
|
||||
|
||||
# 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 = []
|
||||
|
||||
|
||||
# -- 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 = "mirantis"
|
||||
|
||||
# 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 = { "roottarget": "index" }
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
html_theme_path = ["_templates", csp.get_theme_dir()]
|
||||
|
||||
html_add_permalinks = None
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
# html_title = project + ' v' + release + ' | Documentation'
|
||||
html_title = 'Fuel v' + release + ' for OpenStack | Documentation'
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
# html_logo = '_static/fuel-logo.png'
|
||||
html_logo = '_static/fuel_gradient_200.png'
|
||||
|
||||
# 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.
|
||||
html_favicon = '_static/mirantis_icon.ico'
|
||||
|
||||
# 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.
|
||||
# html_last_updated_fmt = '%c, %Z'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
html_use_smartypants = False
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
html_sidebars = {
|
||||
'**': ['searchbox.html', 'globaltoc.html', 'doc_license.html'],
|
||||
}
|
||||
|
||||
# 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
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
html_show_sourcelink = False
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
html_show_sphinx = False
|
||||
|
||||
# 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
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'fueldoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# 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', 'fuel.tex', u'Fuel for OpenStack | Documentation',
|
||||
u'Mirantis Inc.', 'manual'),
|
||||
]
|
||||
|
||||
# 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
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'fuel', u'Fuel for OpenStack | Documentation',
|
||||
[u'Mirantis'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#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', 'fuel', u'Fuel for OpenStack | Documentation',
|
||||
u'Mirantis Inc.', 'fuel', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# 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'
|
||||
# -- Additional Settings -------------------------------------------------------
|
||||
|
||||
|
||||
# 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.inheritance_diagram', 'sphinxcontrib.blockdiag', 'sphinxcontrib.actdiag', 'sphinxcontrib.seqdiag', 'sphinxcontrib.nwdiag']
|
||||
|
||||
# The encoding of source files.
|
||||
source_encoding = 'utf-8'
|
||||
#source_encoding = 'shift_jis'
|
||||
|
||||
# The language for content autogenerated by Sphinx.
|
||||
#language = 'en'
|
||||
#language = 'ja'
|
||||
|
||||
# Enable Antialiasing
|
||||
blockdiag_antialias = True
|
||||
acttdiag_antialias = True
|
||||
seqdiag_antialias = True
|
||||
nwdiag_antialias = True
|
||||
|
||||
extensions += ['rst2pdf.pdfbuilder']
|
||||
pdf_documents = [
|
||||
('relnotes/index', u'Fuel-for-OpenStack-3.1-RelNotes', u'Release Notes',
|
||||
u'2013, Mirantis Inc.')
|
||||
# (master_doc, project, project, copyright),
|
||||
]
|
||||
pdf_stylesheets = ['letter', 'mirantis']
|
||||
pdf_style_path = ['_templates']
|
||||
#pdf_language = "en"
|
||||
# Mode for literal blocks wider than the frame. Can be
|
||||
# overflow, shrink or truncate
|
||||
pdf_fit_mode = "shrink"
|
||||
|
||||
# Section level that forces a break page.
|
||||
# For example: 1 means top-level sections start in a new page
|
||||
# 0 means disabled
|
||||
pdf_break_level = 2
|
||||
|
||||
# When a section starts in a new page, force it to be 'even', 'odd',
|
||||
# or just use 'any'
|
||||
pdf_breakside = 'any'
|
||||
|
||||
# Insert footnotes where they are defined instead of
|
||||
# at the end.
|
||||
#pdf_inline_footnotes = True
|
||||
|
||||
# verbosity level. 0 1 or 2
|
||||
pdf_verbosity = 0
|
||||
|
||||
# If false, no index is generated.
|
||||
pdf_use_index = False
|
||||
|
||||
# If false, no modindex is generated.
|
||||
#pdf_use_modindex = False
|
||||
|
||||
# If false, no coverpage is generated.
|
||||
# pdf_use_coverpage = False
|
||||
|
||||
# Name of the cover page template to use
|
||||
pdf_cover_template = 'mirantiscover.tmpl'
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#pdf_appendices = []
|
||||
|
||||
# Enable experimental feature to split table cells. Use it
|
||||
# if you get "DelayedTable too big" errors
|
||||
#pdf_splittables = False
|
||||
|
||||
# Set the default DPI for images
|
||||
#pdf_default_dpi = 72
|
||||
|
||||
# Enable rst2pdf extension modules (default is only vectorpdf)
|
||||
# you need vectorpdf if you want to use sphinx's graphviz support
|
||||
#pdf_extensions = ['vectorpdf']
|
||||
|
||||
# Page template name for "regular" pages
|
||||
# pdf_page_template = 'cutePage'
|
||||
pdf_page_template = 'oneColumn'
|
||||
|
||||
# Show Table Of Contents at the beginning?
|
||||
pdf_use_toc = False
|
||||
|
||||
# How many levels deep should the table of contents be?
|
||||
pdf_toc_depth = 2
|
||||
|
||||
# Add section number to section references
|
||||
#pdf_use_numbered_links = False
|
||||
|
||||
# Background images fitting mode
|
||||
pdf_fit_background_mode = 'scale'
|
||||
|
||||
pdf_font_path = ['C:\\Windows\\Fonts\\', '/usr/share/fonts', '_fonts']
|
||||
|
|
@ -1,14 +1,11 @@
|
|||
:orphan:
|
||||
|
||||
|
||||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Fuel™ for v|version| Openstack | .. cssclass:: right|
|
||||
| Fuel™ 3.1 for Openstack | .. cssclass:: right|
|
||||
| | |
|
||||
| Release Notes | ###Section### |
|
||||
| | Release Notes |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
||||
.. footer::
|
||||
|
|
@ -16,14 +13,14 @@
|
|||
.. cssclass:: footer-table
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| | .. cssclass:: right|
|
||||
| ©2013, Mirantis Inc. | .. cssclass:: right|
|
||||
| | |
|
||||
| ©2013, Mirantis Inc. | Page ###Page### |
|
||||
| All rights reserved. | Page ###Page### |
|
||||
+--------------------------+----------------------+
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak oneColumn
|
||||
|
||||
.. include:: 0030-release-notes.rst
|
||||
.. include:: /pages/release-notes/v3-1-grizzly-full.rst
|
||||
|
||||
Loading…
Reference in New Issue