Basic structure of TripleO Deployment Guide
* Move _custom & _templates at root, so both doc/ and deploy-guide/ can use it. * Update tox.ini to generate deploy-guide. * Very basic structure of deploy-guide. * Removing duplicated _templates parameter from config.py. Change-Id: Id7b4c22d188fd4f2646ec25194767c3a7afa97c7
This commit is contained in:
parent
42468193ef
commit
3da7042c24
120
deploy-guide/source/conf.py
Normal file
120
deploy-guide/source/conf.py
Normal file
@ -0,0 +1,120 @@
|
|||||||
|
# instack-undercloud documentation build configuration file, created by
|
||||||
|
# sphinx-quickstart on Wed Feb 25 10:56:57 2015.
|
||||||
|
#
|
||||||
|
# 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 sphinx_rtd_theme
|
||||||
|
|
||||||
|
# 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.intersphinx',
|
||||||
|
'oslosphinx'
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# The suffix of source filenames.
|
||||||
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
# The encoding of source files.
|
||||||
|
#source_encoding = 'utf-8-sig'
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = 'index'
|
||||||
|
|
||||||
|
# General information about the project.
|
||||||
|
project = u'TripleO'
|
||||||
|
copyright = u'2015, OpenStack Foundation'
|
||||||
|
bug_tracker = u'Launchpad'
|
||||||
|
bug_tracker_url = u'https://launchpad.net/tripleo'
|
||||||
|
|
||||||
|
# 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.0.0'
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = '3.0.0'
|
||||||
|
|
||||||
|
# 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 = []
|
||||||
|
|
||||||
|
# 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 ---------------------------------------------------
|
||||||
|
|
||||||
|
html_static_path = ['../../_custom']
|
||||||
|
# html_style = 'custom.css'
|
||||||
|
templates_path = ['../../_templates']
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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': '',
|
||||||
|
}
|
||||||
|
|
||||||
|
rst_prolog = """
|
||||||
|
.. |project| replace:: %s
|
||||||
|
.. |bug_tracker| replace:: %s
|
||||||
|
.. |bug_tracker_url| replace:: %s
|
||||||
|
""" % (project, bug_tracker, bug_tracker_url)
|
@ -1,3 +1,7 @@
|
|||||||
|
========================
|
||||||
|
TripleO Deployment Guide
|
||||||
|
========================
|
||||||
|
|
||||||
TripleO is a project aimed at installing, upgrading and operating OpenStack
|
TripleO is a project aimed at installing, upgrading and operating OpenStack
|
||||||
clouds using OpenStack's own cloud facilities as the foundation - building on
|
clouds using OpenStack's own cloud facilities as the foundation - building on
|
||||||
Nova, Ironic, Neutron and Heat to automate cloud management at datacenter
|
Nova, Ironic, Neutron and Heat to automate cloud management at datacenter
|
@ -31,9 +31,6 @@ extensions = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
|
||||||
templates_path = ['_templates']
|
|
||||||
|
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
|
|
||||||
@ -95,9 +92,9 @@ pygments_style = 'sphinx'
|
|||||||
|
|
||||||
# -- Options for HTML output ---------------------------------------------------
|
# -- Options for HTML output ---------------------------------------------------
|
||||||
|
|
||||||
html_static_path = ['_custom']
|
html_static_path = ['../../_custom']
|
||||||
# html_style = 'custom.css'
|
# html_style = 'custom.css'
|
||||||
templates_path = ['_templates']
|
templates_path = ['../../_templates']
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = '%sdoc' % project
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
@ -1,7 +1,10 @@
|
|||||||
Welcome to |project| documentation
|
Welcome to |project| documentation
|
||||||
====================================
|
====================================
|
||||||
|
|
||||||
.. include:: index-introduction.rst
|
TripleO is a project aimed at installing, upgrading and operating OpenStack
|
||||||
|
clouds using OpenStack's own cloud facilities as the foundation - building on
|
||||||
|
Nova, Ironic, Neutron and Heat to automate cloud management at datacenter
|
||||||
|
scale.
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
|
3
tox.ini
3
tox.ini
@ -26,3 +26,6 @@ commands = flake8
|
|||||||
[flake8]
|
[flake8]
|
||||||
show-source = True
|
show-source = True
|
||||||
exclude = .tox,dist,doc,*.egg,build
|
exclude = .tox,dist,doc,*.egg,build
|
||||||
|
|
||||||
|
[testenv:deploy-guide]
|
||||||
|
commands = sphinx-build -a -E -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html
|
||||||
|
Loading…
Reference in New Issue
Block a user