From 239dfb559ca3b49bdce71c45f12201d79d9741fa Mon Sep 17 00:00:00 2001 From: John Dickinson Date: Fri, 7 Jul 2017 10:52:39 -0700 Subject: [PATCH] moved install guide and removed tox env definition Change-Id: I966f849804cd5eeeae566bc7e732c7bf56bc9eaf --- doc/source/index.rst | 1 + .../controller-common_prerequisites.txt | 0 .../source/install}/controller-include.txt | 0 .../install}/controller-install-debian.rst | 0 .../install}/controller-install-obs.rst | 0 .../install}/controller-install-rdo.rst | 0 .../install}/controller-install-ubuntu.rst | 0 .../source/install}/controller-install.rst | 0 .../source/install}/edit_hosts_file.txt | 0 .../install}/environment-networking.rst | 0 .../install}/finalize-installation-obs.rst | 0 .../install}/finalize-installation-rdo.rst | 0 .../finalize-installation-ubuntu-debian.rst | 0 .../source/install}/finalize-installation.rst | 0 .../source/install}/get_started.rst | 0 .../source => doc/source/install}/index.rst | 6 +- .../source/install}/initial-rings.rst | 0 .../source/install}/next-steps.rst | 0 .../source/install}/storage-include1.txt | 0 .../source/install}/storage-include2.txt | 0 .../source/install}/storage-include3.txt | 0 .../source/install}/storage-install-obs.rst | 0 .../source/install}/storage-install-rdo.rst | 0 .../storage-install-ubuntu-debian.rst | 0 .../source/install}/storage-install.rst | 0 .../source => doc/source/install}/verify.rst | 0 install-guide/source/conf.py | 301 ------------------ tox.ini | 3 - 28 files changed, 4 insertions(+), 307 deletions(-) rename {install-guide/source => doc/source/install}/controller-common_prerequisites.txt (100%) rename {install-guide/source => doc/source/install}/controller-include.txt (100%) rename {install-guide/source => doc/source/install}/controller-install-debian.rst (100%) rename {install-guide/source => doc/source/install}/controller-install-obs.rst (100%) rename {install-guide/source => doc/source/install}/controller-install-rdo.rst (100%) rename {install-guide/source => doc/source/install}/controller-install-ubuntu.rst (100%) rename {install-guide/source => doc/source/install}/controller-install.rst (100%) rename {install-guide/source => doc/source/install}/edit_hosts_file.txt (100%) rename {install-guide/source => doc/source/install}/environment-networking.rst (100%) rename {install-guide/source => doc/source/install}/finalize-installation-obs.rst (100%) rename {install-guide/source => doc/source/install}/finalize-installation-rdo.rst (100%) rename {install-guide/source => doc/source/install}/finalize-installation-ubuntu-debian.rst (100%) rename {install-guide/source => doc/source/install}/finalize-installation.rst (100%) rename {install-guide/source => doc/source/install}/get_started.rst (100%) rename {install-guide/source => doc/source/install}/index.rst (86%) rename {install-guide/source => doc/source/install}/initial-rings.rst (100%) rename {install-guide/source => doc/source/install}/next-steps.rst (100%) rename {install-guide/source => doc/source/install}/storage-include1.txt (100%) rename {install-guide/source => doc/source/install}/storage-include2.txt (100%) rename {install-guide/source => doc/source/install}/storage-include3.txt (100%) rename {install-guide/source => doc/source/install}/storage-install-obs.rst (100%) rename {install-guide/source => doc/source/install}/storage-install-rdo.rst (100%) rename {install-guide/source => doc/source/install}/storage-install-ubuntu-debian.rst (100%) rename {install-guide/source => doc/source/install}/storage-install.rst (100%) rename {install-guide/source => doc/source/install}/verify.rst (100%) delete mode 100644 install-guide/source/conf.py diff --git a/doc/source/index.rst b/doc/source/index.rst index ecc79c25..63df7908 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -94,6 +94,7 @@ Administrator Documentation logs ops_runbook/index admin/index + install/index Object Storage v1 REST API Documentation ======================================== diff --git a/install-guide/source/controller-common_prerequisites.txt b/doc/source/install/controller-common_prerequisites.txt similarity index 100% rename from install-guide/source/controller-common_prerequisites.txt rename to doc/source/install/controller-common_prerequisites.txt diff --git a/install-guide/source/controller-include.txt b/doc/source/install/controller-include.txt similarity index 100% rename from install-guide/source/controller-include.txt rename to doc/source/install/controller-include.txt diff --git a/install-guide/source/controller-install-debian.rst b/doc/source/install/controller-install-debian.rst similarity index 100% rename from install-guide/source/controller-install-debian.rst rename to doc/source/install/controller-install-debian.rst diff --git a/install-guide/source/controller-install-obs.rst b/doc/source/install/controller-install-obs.rst similarity index 100% rename from install-guide/source/controller-install-obs.rst rename to doc/source/install/controller-install-obs.rst diff --git a/install-guide/source/controller-install-rdo.rst b/doc/source/install/controller-install-rdo.rst similarity index 100% rename from install-guide/source/controller-install-rdo.rst rename to doc/source/install/controller-install-rdo.rst diff --git a/install-guide/source/controller-install-ubuntu.rst b/doc/source/install/controller-install-ubuntu.rst similarity index 100% rename from install-guide/source/controller-install-ubuntu.rst rename to doc/source/install/controller-install-ubuntu.rst diff --git a/install-guide/source/controller-install.rst b/doc/source/install/controller-install.rst similarity index 100% rename from install-guide/source/controller-install.rst rename to doc/source/install/controller-install.rst diff --git a/install-guide/source/edit_hosts_file.txt b/doc/source/install/edit_hosts_file.txt similarity index 100% rename from install-guide/source/edit_hosts_file.txt rename to doc/source/install/edit_hosts_file.txt diff --git a/install-guide/source/environment-networking.rst b/doc/source/install/environment-networking.rst similarity index 100% rename from install-guide/source/environment-networking.rst rename to doc/source/install/environment-networking.rst diff --git a/install-guide/source/finalize-installation-obs.rst b/doc/source/install/finalize-installation-obs.rst similarity index 100% rename from install-guide/source/finalize-installation-obs.rst rename to doc/source/install/finalize-installation-obs.rst diff --git a/install-guide/source/finalize-installation-rdo.rst b/doc/source/install/finalize-installation-rdo.rst similarity index 100% rename from install-guide/source/finalize-installation-rdo.rst rename to doc/source/install/finalize-installation-rdo.rst diff --git a/install-guide/source/finalize-installation-ubuntu-debian.rst b/doc/source/install/finalize-installation-ubuntu-debian.rst similarity index 100% rename from install-guide/source/finalize-installation-ubuntu-debian.rst rename to doc/source/install/finalize-installation-ubuntu-debian.rst diff --git a/install-guide/source/finalize-installation.rst b/doc/source/install/finalize-installation.rst similarity index 100% rename from install-guide/source/finalize-installation.rst rename to doc/source/install/finalize-installation.rst diff --git a/install-guide/source/get_started.rst b/doc/source/install/get_started.rst similarity index 100% rename from install-guide/source/get_started.rst rename to doc/source/install/get_started.rst diff --git a/install-guide/source/index.rst b/doc/source/install/index.rst similarity index 86% rename from install-guide/source/index.rst rename to doc/source/install/index.rst index c6aee024..026e9228 100644 --- a/install-guide/source/index.rst +++ b/doc/source/install/index.rst @@ -1,6 +1,6 @@ -====================== -Object Storage service -====================== +============================ +Object Storage Install Guide +============================ .. toctree:: :maxdepth: 2 diff --git a/install-guide/source/initial-rings.rst b/doc/source/install/initial-rings.rst similarity index 100% rename from install-guide/source/initial-rings.rst rename to doc/source/install/initial-rings.rst diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst similarity index 100% rename from install-guide/source/next-steps.rst rename to doc/source/install/next-steps.rst diff --git a/install-guide/source/storage-include1.txt b/doc/source/install/storage-include1.txt similarity index 100% rename from install-guide/source/storage-include1.txt rename to doc/source/install/storage-include1.txt diff --git a/install-guide/source/storage-include2.txt b/doc/source/install/storage-include2.txt similarity index 100% rename from install-guide/source/storage-include2.txt rename to doc/source/install/storage-include2.txt diff --git a/install-guide/source/storage-include3.txt b/doc/source/install/storage-include3.txt similarity index 100% rename from install-guide/source/storage-include3.txt rename to doc/source/install/storage-include3.txt diff --git a/install-guide/source/storage-install-obs.rst b/doc/source/install/storage-install-obs.rst similarity index 100% rename from install-guide/source/storage-install-obs.rst rename to doc/source/install/storage-install-obs.rst diff --git a/install-guide/source/storage-install-rdo.rst b/doc/source/install/storage-install-rdo.rst similarity index 100% rename from install-guide/source/storage-install-rdo.rst rename to doc/source/install/storage-install-rdo.rst diff --git a/install-guide/source/storage-install-ubuntu-debian.rst b/doc/source/install/storage-install-ubuntu-debian.rst similarity index 100% rename from install-guide/source/storage-install-ubuntu-debian.rst rename to doc/source/install/storage-install-ubuntu-debian.rst diff --git a/install-guide/source/storage-install.rst b/doc/source/install/storage-install.rst similarity index 100% rename from install-guide/source/storage-install.rst rename to doc/source/install/storage-install.rst diff --git a/install-guide/source/verify.rst b/doc/source/install/verify.rst similarity index 100% rename from install-guide/source/verify.rst rename to doc/source/install/verify.rst diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py deleted file mode 100644 index c44eda9a..00000000 --- a/install-guide/source/conf.py +++ /dev/null @@ -1,301 +0,0 @@ -# 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 -# -# 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. -# -# 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 os -# import sys -from swift import __version__ - - -import openstackdocstheme - -# 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. -# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' -# extensions = - -# 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 = 'index' - -# General information about the project. -project = u'Installation Guide for Object Storage Service' -bug_tag = u'install-guide' -copyright = u'2016, 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 = __version__.rsplit('.', 1)[0] -# The full version, including alpha/beta/rc tags. -release = __version__ - -# A few variables have to be set for the log-a-bug feature. -# giturl: The location of conf.py on Git. Must be set manually. -# gitsha: The SHA checksum of the bug description. Automatically extracted from git log. -# bug_tag: Tag for categorizing the bug. Must be set manually. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/swift/tree/install-guide/source' -git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" -gitsha = os.popen(git_cmd).read().strip('\n') -html_context = {"gitsha": gitsha, "bug_tag": bug_tag, - "giturl": giturl, - "bug_project": "swift"} - -# 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 = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - - -# -- 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 = 'openstackdocs' - -# 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 = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# 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 = None - -# 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 = None - -# 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 = [] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# So that we can enable "log-a-bug" links from each output HTML page, this -# variable must be set to a format that includes year, month, day, hours and -# minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# 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 = False - -# 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 = True - -# 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 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 = 'install-guide' - -# If true, publish source files -html_copy_source = False - -# -- 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, or own class]). -latex_documents = [ - ('index', 'InstallGuide.tex', u'Install Guide', - u'OpenStack contributors', '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', 'installguide', u'Install Guide', - [u'OpenStack contributors'], 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', 'InstallGuide', u'Install Guide', - u'OpenStack contributors', 'InstallGuide', - 'This guide shows OpenStack end users how to install ' - 'an OpenStack cloud.', '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' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] - -# -- Options for PDF output -------------------------------------------------- - -pdf_documents = [ - ('index', u'InstallGuide', u'Install Guide', - u'OpenStack contributors') -] diff --git a/tox.ini b/tox.ini index 5a8f0ef7..ae770782 100644 --- a/tox.ini +++ b/tox.ini @@ -92,9 +92,6 @@ commands = rm -rf api-ref/build sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html -[testenv:install-guide] -commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html - [testenv:bandit] deps = -r{toxinidir}/test-requirements.txt commands = bandit -c bandit.yaml -r swift -n 5