From 3da7042c2435db50a54d2a319f292144b34befa0 Mon Sep 17 00:00:00 2001 From: Emilien Macchi Date: Fri, 24 Mar 2017 11:23:03 -0400 Subject: [PATCH] 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 --- .../admonition_selector.js | 0 {doc/source/_custom => _custom}/cookies.js | 0 {doc/source/_custom => _custom}/custom.css | 0 {doc/source/_custom => _custom}/expandable.js | 0 {doc/source/_custom => _custom}/jquery.nav.js | 0 .../_custom => _custom}/jquery.scrollTo.js | 0 {doc/source/_custom => _custom}/menu.js | 0 .../_templates => _templates}/layout.html | 0 deploy-guide/source/conf.py | 120 ++++++++++++++++++ .../source/index.rst | 4 + doc/source/conf.py | 7 +- doc/source/index.rst | 5 +- tox.ini | 3 + 13 files changed, 133 insertions(+), 6 deletions(-) rename {doc/source/_custom => _custom}/admonition_selector.js (100%) rename {doc/source/_custom => _custom}/cookies.js (100%) rename {doc/source/_custom => _custom}/custom.css (100%) rename {doc/source/_custom => _custom}/expandable.js (100%) rename {doc/source/_custom => _custom}/jquery.nav.js (100%) rename {doc/source/_custom => _custom}/jquery.scrollTo.js (100%) rename {doc/source/_custom => _custom}/menu.js (100%) rename {doc/source/_templates => _templates}/layout.html (100%) create mode 100644 deploy-guide/source/conf.py rename doc/source/index-introduction.rst => deploy-guide/source/index.rst (75%) diff --git a/doc/source/_custom/admonition_selector.js b/_custom/admonition_selector.js similarity index 100% rename from doc/source/_custom/admonition_selector.js rename to _custom/admonition_selector.js diff --git a/doc/source/_custom/cookies.js b/_custom/cookies.js similarity index 100% rename from doc/source/_custom/cookies.js rename to _custom/cookies.js diff --git a/doc/source/_custom/custom.css b/_custom/custom.css similarity index 100% rename from doc/source/_custom/custom.css rename to _custom/custom.css diff --git a/doc/source/_custom/expandable.js b/_custom/expandable.js similarity index 100% rename from doc/source/_custom/expandable.js rename to _custom/expandable.js diff --git a/doc/source/_custom/jquery.nav.js b/_custom/jquery.nav.js similarity index 100% rename from doc/source/_custom/jquery.nav.js rename to _custom/jquery.nav.js diff --git a/doc/source/_custom/jquery.scrollTo.js b/_custom/jquery.scrollTo.js similarity index 100% rename from doc/source/_custom/jquery.scrollTo.js rename to _custom/jquery.scrollTo.js diff --git a/doc/source/_custom/menu.js b/_custom/menu.js similarity index 100% rename from doc/source/_custom/menu.js rename to _custom/menu.js diff --git a/doc/source/_templates/layout.html b/_templates/layout.html similarity index 100% rename from doc/source/_templates/layout.html rename to _templates/layout.html diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py new file mode 100644 index 00000000..745f26a5 --- /dev/null +++ b/deploy-guide/source/conf.py @@ -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) diff --git a/doc/source/index-introduction.rst b/deploy-guide/source/index.rst similarity index 75% rename from doc/source/index-introduction.rst rename to deploy-guide/source/index.rst index 684fa07d..95f7a2e3 100644 --- a/doc/source/index-introduction.rst +++ b/deploy-guide/source/index.rst @@ -1,3 +1,7 @@ +======================== +TripleO Deployment Guide +======================== + 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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 9e55042d..745f26a5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,9 +31,6 @@ extensions = [ ] -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - # The suffix of source filenames. source_suffix = '.rst' @@ -95,9 +92,9 @@ pygments_style = 'sphinx' # -- Options for HTML output --------------------------------------------------- -html_static_path = ['_custom'] +html_static_path = ['../../_custom'] # html_style = 'custom.css' -templates_path = ['_templates'] +templates_path = ['../../_templates'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/doc/source/index.rst b/doc/source/index.rst index d99a465c..157d5e30 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,7 +1,10 @@ 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: diff --git a/tox.ini b/tox.ini index cd90b7f8..21e41962 100644 --- a/tox.ini +++ b/tox.ini @@ -26,3 +26,6 @@ commands = flake8 [flake8] show-source = True 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