summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortikitavi <rtikitavi@gmail.com>2017-09-19 19:22:45 +0300
committertikitavi <rtikitavi@gmail.com>2017-09-28 16:55:45 +0300
commitaaf1fc94f89b4b3fc312c6eb768b61e5fb3267c3 (patch)
tree5c3ec6c37a0a5a25da38e885156601768a4e4571
parent9e91db17aa17f342ecfacd62bda18b8c0e086b1e (diff)
Move install guides from install-guide/ to doc/source/install
Update documentation index page Change-Id: I94b832638d9c1460fbefd1a61a850496b07124ab
Notes
Notes (review): Code-Review+2: Feodor Tersin <ftersin@hotmail.com> Workflow+1: Feodor Tersin <ftersin@hotmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Sun, 01 Oct 2017 11:22:38 +0000 Reviewed-on: https://review.openstack.org/505323 Project: openstack/ec2-api Branch: refs/heads/master
-rw-r--r--doc/source/index.rst24
-rw-r--r--doc/source/install/credentials-creation.rst (renamed from install-guide/source/credentials-creation.rst)0
-rw-r--r--doc/source/install/database-creation.rst (renamed from install-guide/source/database-creation.rst)0
-rw-r--r--doc/source/install/endpoints-creation.rst (renamed from install-guide/source/endpoints-creation.rst)0
-rw-r--r--doc/source/install/get-started.rst (renamed from install-guide/source/get-started.rst)0
-rw-r--r--doc/source/install/index.rst (renamed from install-guide/source/index.rst)2
-rw-r--r--doc/source/install/install-ubuntu.rst (renamed from install-guide/source/install-ubuntu.rst)0
-rw-r--r--doc/source/install/install.rst (renamed from install-guide/source/install.rst)0
-rw-r--r--doc/source/install/next-steps.rst (renamed from install-guide/source/next-steps.rst)0
-rw-r--r--doc/source/install/verify.rst (renamed from install-guide/source/verify.rst)0
-rw-r--r--install-guide/source/conf.py301
-rw-r--r--tox.ini3
12 files changed, 24 insertions, 306 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5b812ee..27345ad 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,7 +11,29 @@ well.
11It doesn't replace existing nova EC2 API service in deployment, it gets 11It doesn't replace existing nova EC2 API service in deployment, it gets
12installed to a different port (8788 by default). 12installed to a different port (8788 by default).
13 13
14Contents: 14Installing EC2API
15=================
16
17.. toctree::
18 :maxdepth: 1
19
20 install/index
21
22Configuring EC2API
23==================
24
25.. toctree::
26 :maxdepth: 1
27
28 configuration/index
29
30EC2API Reference
31==================
32
33- `EC2-API Reference`_
34
35 .. _`EC2-API Reference`: https://developer.openstack.org/api-ref/ec2-api/
36
15 37
16.. toctree:: 38.. toctree::
17 :maxdepth: 1 39 :maxdepth: 1
diff --git a/install-guide/source/credentials-creation.rst b/doc/source/install/credentials-creation.rst
index 59001de..59001de 100644
--- a/install-guide/source/credentials-creation.rst
+++ b/doc/source/install/credentials-creation.rst
diff --git a/install-guide/source/database-creation.rst b/doc/source/install/database-creation.rst
index 6911c48..6911c48 100644
--- a/install-guide/source/database-creation.rst
+++ b/doc/source/install/database-creation.rst
diff --git a/install-guide/source/endpoints-creation.rst b/doc/source/install/endpoints-creation.rst
index 3e2837d..3e2837d 100644
--- a/install-guide/source/endpoints-creation.rst
+++ b/doc/source/install/endpoints-creation.rst
diff --git a/install-guide/source/get-started.rst b/doc/source/install/get-started.rst
index e79caec..e79caec 100644
--- a/install-guide/source/get-started.rst
+++ b/doc/source/install/get-started.rst
diff --git a/install-guide/source/index.rst b/doc/source/install/index.rst
index ba93ae5..fc54c83 100644
--- a/install-guide/source/index.rst
+++ b/doc/source/install/index.rst
@@ -1,5 +1,5 @@
1===================== 1=====================
2EC2-API service 2Installing EC2-API
3===================== 3=====================
4 4
5.. toctree:: 5.. toctree::
diff --git a/install-guide/source/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst
index d73f830..d73f830 100644
--- a/install-guide/source/install-ubuntu.rst
+++ b/doc/source/install/install-ubuntu.rst
diff --git a/install-guide/source/install.rst b/doc/source/install/install.rst
index 92bf62c..92bf62c 100644
--- a/install-guide/source/install.rst
+++ b/doc/source/install/install.rst
diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst
index 1a14807..1a14807 100644
--- a/install-guide/source/next-steps.rst
+++ b/doc/source/install/next-steps.rst
diff --git a/install-guide/source/verify.rst b/doc/source/install/verify.rst
index 53cd020..53cd020 100644
--- a/install-guide/source/verify.rst
+++ b/doc/source/install/verify.rst
diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py
deleted file mode 100644
index 317fac0..0000000
--- a/install-guide/source/conf.py
+++ /dev/null
@@ -1,301 +0,0 @@
1# Licensed under the Apache License, Version 2.0 (the "License");
2# you may not use this file except in compliance with the License.
3# You may obtain a copy of the License at
4#
5# http://www.apache.org/licenses/LICENSE-2.0
6#
7# Unless required by applicable law or agreed to in writing, software
8# distributed under the License is distributed on an "AS IS" BASIS,
9# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10# implied.
11# See the License for the specific language governing permissions and
12# limitations under the License.
13
14# This file is execfile()d with the current directory set to its
15# containing dir.
16#
17# Note that not all possible configuration values are present in this
18# autogenerated file.
19#
20# All configuration values have a default; values that are commented out
21# serve to show the default.
22
23import os
24# import sys
25
26
27import openstackdocstheme
28
29# If extensions (or modules to document with autodoc) are in another directory,
30# add these directories to sys.path here. If the directory is relative to the
31# documentation root, use os.path.abspath to make it absolute, like shown here.
32# sys.path.insert(0, os.path.abspath('.'))
33
34# -- General configuration ------------------------------------------------
35
36# If your documentation needs a minimal Sphinx version, state it here.
37# needs_sphinx = '1.0'
38
39# Add any Sphinx extension module names here, as strings. They can be
40# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41# ones.
42# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
43# extensions =
44
45# Add any paths that contain templates here, relative to this directory.
46# templates_path = ['_templates']
47
48# The suffix of source filenames.
49source_suffix = '.rst'
50
51# The encoding of source files.
52# source_encoding = 'utf-8-sig'
53
54# The master toctree document.
55master_doc = 'index'
56
57# General information about the project.
58project = u'Installation Guide for ec2-api Service'
59bug_tag = u'install-guide'
60copyright = u'2016, OpenStack contributors'
61
62# The version info for the project you're documenting, acts as replacement for
63# |version| and |release|, also used in various other places throughout the
64# built documents.
65#
66# The short X.Y version.
67version = '0.1'
68# The full version, including alpha/beta/rc tags.
69release = '0.1'
70
71# A few variables have to be set for the log-a-bug feature.
72# giturl: The location of conf.py on Git. Must be set manually.
73# gitsha: The SHA checksum of the bug description. Automatically extracted
74# from git log.
75# bug_tag: Tag for categorizing the bug. Must be set manually.
76# These variables are passed to the logabug code via html_context.
77giturl = u'http://git.openstack.org/cgit/openstack/ec2-api/tree/install-guide/source' # noqa
78git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
79gitsha = os.popen(git_cmd).read().strip('\n')
80html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
81 "giturl": giturl,
82 "bug_project": "ec2-api"}
83
84# The language for content autogenerated by Sphinx. Refer to documentation
85# for a list of supported languages.
86# language = None
87
88# There are two options for replacing |today|: either, you set today to some
89# non-false value, then it is used:
90# today = ''
91# Else, today_fmt is used as the format for a strftime call.
92# today_fmt = '%B %d, %Y'
93
94# List of patterns, relative to source directory, that match files and
95# directories to ignore when looking for source files.
96exclude_patterns = ["endpoints-creation.rst"]
97
98# The reST default role (used for this markup: `text`) to use for all
99# documents.
100# default_role = None
101
102# If true, '()' will be appended to :func: etc. cross-reference text.
103# add_function_parentheses = True
104
105# If true, the current module name will be prepended to all description
106# unit titles (such as .. function::).
107# add_module_names = True
108
109# If true, sectionauthor and moduleauthor directives will be shown in the
110# output. They are ignored by default.
111# show_authors = False
112
113# The name of the Pygments (syntax highlighting) style to use.
114pygments_style = 'sphinx'
115
116# A list of ignored prefixes for module index sorting.
117# modindex_common_prefix = []
118
119# If true, keep warnings as "system message" paragraphs in the built documents.
120# keep_warnings = False
121
122
123# -- Options for HTML output ----------------------------------------------
124
125# The theme to use for HTML and HTML Help pages. See the documentation for
126# a list of builtin themes.
127html_theme = 'openstackdocs'
128
129# Theme options are theme-specific and customize the look and feel of a theme
130# further. For a list of options available for each theme, see the
131# documentation.
132# html_theme_options = {}
133
134# Add any paths that contain custom themes here, relative to this directory.
135html_theme_path = [openstackdocstheme.get_html_theme_path()]
136
137# The name for this set of Sphinx documents. If None, it defaults to
138# "<project> v<release> documentation".
139# html_title = None
140
141# A shorter title for the navigation bar. Default is the same as html_title.
142# html_short_title = None
143
144# The name of an image file (relative to this directory) to place at the top
145# of the sidebar.
146# html_logo = None
147
148# The name of an image file (within the static path) to use as favicon of the
149# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
150# pixels large.
151# html_favicon = None
152
153# Add any paths that contain custom static files (such as style sheets) here,
154# relative to this directory. They are copied after the builtin static files,
155# so a file named "default.css" will overwrite the builtin "default.css".
156# html_static_path = []
157
158# Add any extra paths that contain custom files (such as robots.txt or
159# .htaccess) here, relative to this directory. These files are copied
160# directly to the root of the documentation.
161# html_extra_path = []
162
163# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
164# using the given strftime format.
165# So that we can enable "log-a-bug" links from each output HTML page, this
166# variable must be set to a format that includes year, month, day, hours and
167# minutes.
168html_last_updated_fmt = '%Y-%m-%d %H:%M'
169
170
171# If true, SmartyPants will be used to convert quotes and dashes to
172# typographically correct entities.
173# html_use_smartypants = True
174
175# Custom sidebar templates, maps document names to template names.
176# html_sidebars = {}
177
178# Additional templates that should be rendered to pages, maps page names to
179# template names.
180# html_additional_pages = {}
181
182# If false, no module index is generated.
183# html_domain_indices = True
184
185# If false, no index is generated.
186html_use_index = True
187
188# If true, the index is split into individual pages for each letter.
189# html_split_index = False
190
191# If true, links to the reST sources are added to the pages.
192html_show_sourcelink = True
193
194# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
195# html_show_sphinx = True
196
197# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
198# html_show_copyright = True
199
200# If true, an OpenSearch description file will be output, and all pages will
201# contain a <link> tag referring to it. The value of this option must be the
202# base URL from which the finished HTML is served.
203# html_use_opensearch = ''
204
205# This is the file name suffix for HTML files (e.g. ".xhtml").
206# html_file_suffix = None
207
208# Output file base name for HTML help builder.
209htmlhelp_basename = 'install-guide'
210
211# If true, publish source files
212html_copy_source = False
213
214# -- Options for LaTeX output ---------------------------------------------
215
216latex_elements = {
217 # The paper size ('letterpaper' or 'a4paper').
218 # 'papersize': 'letterpaper',
219
220 # The font size ('10pt', '11pt' or '12pt').
221 # 'pointsize': '10pt',
222
223 # Additional stuff for the LaTeX preamble.
224 # 'preamble': '',
225}
226
227# Grouping the document tree into LaTeX files. List of tuples
228# (source start file, target name, title,
229# author, documentclass [howto, manual, or own class]).
230latex_documents = [
231 ('index', 'InstallGuide.tex', u'Install Guide',
232 u'OpenStack contributors', 'manual'),
233]
234
235# The name of an image file (relative to this directory) to place at the top of
236# the title page.
237# latex_logo = None
238
239# For "manual" documents, if this is true, then toplevel headings are parts,
240# not chapters.
241# latex_use_parts = False
242
243# If true, show page references after internal links.
244# latex_show_pagerefs = False
245
246# If true, show URL addresses after external links.
247# latex_show_urls = False
248
249# Documents to append as an appendix to all manuals.
250# latex_appendices = []
251
252# If false, no module index is generated.
253# latex_domain_indices = True
254
255
256# -- Options for manual page output ---------------------------------------
257
258# One entry per manual page. List of tuples
259# (source start file, name, description, authors, manual section).
260man_pages = [
261 ('index', 'installguide', u'Install Guide',
262 [u'OpenStack contributors'], 1)
263]
264
265# If true, show URL addresses after external links.
266# man_show_urls = False
267
268
269# -- Options for Texinfo output -------------------------------------------
270
271# Grouping the document tree into Texinfo files. List of tuples
272# (source start file, target name, title, author,
273# dir menu entry, description, category)
274texinfo_documents = [
275 ('index', 'InstallGuide', u'Install Guide',
276 u'OpenStack contributors', 'InstallGuide',
277 'This guide shows OpenStack end users how to install '
278 'an OpenStack cloud.', 'Miscellaneous'),
279]
280
281# Documents to append as an appendix to all manuals.
282# texinfo_appendices = []
283
284# If false, no module index is generated.
285# texinfo_domain_indices = True
286
287# How to display URL addresses: 'footnote', 'no', or 'inline'.
288# texinfo_show_urls = 'footnote'
289
290# If true, do not generate a @detailmenu in the "Top" node's menu.
291# texinfo_no_detailmenu = False
292
293# -- Options for Internationalization output ------------------------------
294locale_dirs = ['locale/']
295
296# -- Options for PDF output --------------------------------------------------
297
298pdf_documents = [
299 ('index', u'InstallGuide', u'Install Guide',
300 u'OpenStack contributors')
301]
diff --git a/tox.ini b/tox.ini
index e1f376b..9ea1d08 100644
--- a/tox.ini
+++ b/tox.ini
@@ -61,9 +61,6 @@ max-complexity=25
61[hacking] 61[hacking]
62local-check-factory = ec2api.hacking.checks.factory 62local-check-factory = ec2api.hacking.checks.factory
63 63
64[testenv:install-guide]
65commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
66
67[testenv:api-ref] 64[testenv:api-ref]
68# This environment is called from CI scripts to test and publish 65# This environment is called from CI scripts to test and publish
69# the API Ref to developer.openstack.org. 66# the API Ref to developer.openstack.org.