Skip to content

Commit 514c820

Browse files
Jenkinsopenstack-gerrit
authored andcommitted
Merge "Convert all HTML doc to RST"
2 parents cac1317 + 09e550c commit 514c820

42 files changed

Lines changed: 2836 additions & 2878 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

doc/source/changes.html

Lines changed: 0 additions & 70 deletions
This file was deleted.

doc/source/changes.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
`DevStack </>`__
2+
3+
- `Overview <overview.html>`__
4+
- `Changes <changes.html>`__
5+
- `FAQ <faq.html>`__
6+
- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
7+
- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
8+
9+
Recent Changes What's been happening?
10+
-------------------------------------
11+
12+
These are the commits to DevStack for the last six months. For the
13+
complete list see `the DevStack project in
14+
Gerrit <https://review.openstack.org/#/q/status:merged+project:openstack-dev/devstack,n,z>`__.
15+
16+
© Openstack Foundation 2011-2014 — An
17+
`OpenStack <https://www.openstack.org/>`__
18+
`program <https://wiki.openstack.org/wiki/Programs>`__

doc/source/conf.py

Lines changed: 263 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,263 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Tempest documentation build configuration file, created by
4+
# sphinx-quickstart on Tue May 21 17:43:32 2013.
5+
#
6+
# This file is execfile()d with the current directory set to its containing dir.
7+
#
8+
# Note that not all possible configuration values are present in this
9+
# autogenerated file.
10+
#
11+
# All configuration values have a default; values that are commented out
12+
# serve to show the default.
13+
14+
import sys
15+
import os
16+
17+
# If extensions (or modules to document with autodoc) are in another directory,
18+
# add these directories to sys.path here. If the directory is relative to the
19+
# documentation root, use os.path.abspath to make it absolute, like shown here.
20+
#sys.path.insert(0, os.path.abspath('.'))
21+
22+
# -- General configuration -----------------------------------------------------
23+
24+
# If your documentation needs a minimal Sphinx version, state it here.
25+
#needs_sphinx = '1.0'
26+
27+
# Add any Sphinx extension module names here, as strings. They can be extensions
28+
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29+
extensions = [ 'oslosphinx' ]
30+
31+
todo_include_todos = True
32+
33+
# Add any paths that contain templates here, relative to this directory.
34+
templates_path = ['_templates']
35+
36+
# The suffix of source filenames.
37+
source_suffix = '.rst'
38+
39+
# The encoding of source files.
40+
#source_encoding = 'utf-8-sig'
41+
42+
# The master toctree document.
43+
master_doc = 'index'
44+
45+
# General information about the project.
46+
project = u'DevStack'
47+
copyright = u'2014, OpenStack Foundation'
48+
49+
# The language for content autogenerated by Sphinx. Refer to documentation
50+
# for a list of supported languages.
51+
#language = None
52+
53+
# There are two options for replacing |today|: either, you set today to some
54+
# non-false value, then it is used:
55+
#today = ''
56+
# Else, today_fmt is used as the format for a strftime call.
57+
#today_fmt = '%B %d, %Y'
58+
59+
# List of patterns, relative to source directory, that match files and
60+
# directories to ignore when looking for source files.
61+
exclude_patterns = ['_build']
62+
63+
# The reST default role (used for this markup: `text`) to use for all documents.
64+
#default_role = None
65+
66+
# If true, '()' will be appended to :func: etc. cross-reference text.
67+
#add_function_parentheses = True
68+
69+
# If true, the current module name will be prepended to all description
70+
# unit titles (such as .. function::).
71+
add_module_names = False
72+
73+
# If true, sectionauthor and moduleauthor directives will be shown in the
74+
# output. They are ignored by default.
75+
show_authors = False
76+
77+
# The name of the Pygments (syntax highlighting) style to use.
78+
pygments_style = 'sphinx'
79+
80+
# A list of ignored prefixes for module index sorting.
81+
modindex_common_prefix = ['DevStack-doc.']
82+
83+
# -- Options for man page output ----------------------------------------------
84+
man_pages = []
85+
86+
# -- Options for HTML output ---------------------------------------------------
87+
88+
# The theme to use for HTML and HTML Help pages. See the documentation for
89+
# a list of builtin themes.
90+
html_theme = 'nature'
91+
92+
# Theme options are theme-specific and customize the look and feel of a theme
93+
# further. For a list of options available for each theme, see the
94+
# documentation.
95+
#html_theme_options = {}
96+
97+
# Add any paths that contain custom themes here, relative to this directory.
98+
#html_theme_path = []
99+
100+
# The name for this set of Sphinx documents. If None, it defaults to
101+
# "<project> v<release> documentation".
102+
#html_title = None
103+
104+
# A shorter title for the navigation bar. Default is the same as html_title.
105+
#html_short_title = None
106+
107+
# The name of an image file (relative to this directory) to place at the top
108+
# of the sidebar.
109+
#html_logo = None
110+
111+
# The name of an image file (within the static path) to use as favicon of the
112+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
113+
# pixels large.
114+
#html_favicon = None
115+
116+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
117+
# using the given strftime format.
118+
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
119+
html_last_updated_fmt = os.popen(git_cmd).read()
120+
121+
# If true, SmartyPants will be used to convert quotes and dashes to
122+
# typographically correct entities.
123+
#html_use_smartypants = True
124+
125+
# Custom sidebar templates, maps document names to template names.
126+
#html_sidebars = {}
127+
128+
# Additional templates that should be rendered to pages, maps page names to
129+
# template names.
130+
#html_additional_pages = {}
131+
132+
# If false, no module index is generated.
133+
html_domain_indices = False
134+
135+
# If false, no index is generated.
136+
html_use_index = False
137+
138+
# If true, the index is split into individual pages for each letter.
139+
#html_split_index = False
140+
141+
# If true, links to the reST sources are added to the pages.
142+
#html_show_sourcelink = True
143+
144+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
145+
#html_show_sphinx = True
146+
147+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
148+
#html_show_copyright = True
149+
150+
# If true, an OpenSearch description file will be output, and all pages will
151+
# contain a <link> tag referring to it. The value of this option must be the
152+
# base URL from which the finished HTML is served.
153+
#html_use_opensearch = ''
154+
155+
# This is the file name suffix for HTML files (e.g. ".xhtml").
156+
#html_file_suffix = None
157+
158+
# Output file base name for HTML help builder.
159+
htmlhelp_basename = 'DevStack-doc'
160+
161+
162+
# -- Options for LaTeX output --------------------------------------------------
163+
164+
latex_elements = {
165+
# The paper size ('letterpaper' or 'a4paper').
166+
#'papersize': 'letterpaper',
167+
168+
# The font size ('10pt', '11pt' or '12pt').
169+
#'pointsize': '10pt',
170+
171+
# Additional stuff for the LaTeX preamble.
172+
#'preamble': '',
173+
}
174+
175+
# Grouping the document tree into LaTeX files. List of tuples
176+
# (source start file, target name, title, author, documentclass [howto/manual]).
177+
latex_documents = [
178+
('index', 'DevStack-doc.tex', u'DevStack Docs',
179+
u'OpenStack DevStack Team', 'manual'),
180+
]
181+
182+
# The name of an image file (relative to this directory) to place at the top of
183+
# the title page.
184+
#latex_logo = None
185+
186+
# For "manual" documents, if this is true, then toplevel headings are parts,
187+
# not chapters.
188+
#latex_use_parts = False
189+
190+
# If true, show page references after internal links.
191+
#latex_show_pagerefs = False
192+
193+
# If true, show URL addresses after external links.
194+
#latex_show_urls = False
195+
196+
# Documents to append as an appendix to all manuals.
197+
#latex_appendices = []
198+
199+
# If false, no module index is generated.
200+
#latex_domain_indices = True
201+
202+
# -- Options for Texinfo output ------------------------------------------------
203+
204+
# Grouping the document tree into Texinfo files. List of tuples
205+
# (source start file, target name, title, author,
206+
# dir menu entry, description, category)
207+
texinfo_documents = [
208+
('index', 'DevStack-doc', u'DevStack Docs',
209+
u'OpenStack DevStack Team', 'DevStack-doc', 'DevStack documentation',
210+
'Miscellaneous'),
211+
]
212+
213+
# Documents to append as an appendix to all manuals.
214+
#texinfo_appendices = []
215+
216+
# If false, no module index is generated.
217+
#texinfo_domain_indices = True
218+
219+
# How to display URL addresses: 'footnote', 'no', or 'inline'.
220+
#texinfo_show_urls = 'footnote'
221+
222+
223+
# -- Options for Epub output ---------------------------------------------------
224+
225+
# Bibliographic Dublin Core info.
226+
epub_title = u'DevStack Documentation'
227+
epub_author = u'OpenStack DevStack Team'
228+
epub_publisher = u'OpenStack DevStack Team'
229+
epub_copyright = u'2014, OpenStack DevStack Team'
230+
231+
# The language of the text. It defaults to the language option
232+
# or en if the language is not set.
233+
#epub_language = ''
234+
235+
# The scheme of the identifier. Typical schemes are ISBN or URL.
236+
#epub_scheme = ''
237+
238+
# The unique identifier of the text. This can be a ISBN number
239+
# or the project homepage.
240+
#epub_identifier = ''
241+
242+
# A unique identification for the text.
243+
#epub_uid = ''
244+
245+
# A tuple containing the cover image and cover page html template filenames.
246+
#epub_cover = ()
247+
248+
# HTML files that should be inserted before the pages created by sphinx.
249+
# The format is a list of tuples containing the path and title.
250+
#epub_pre_files = []
251+
252+
# HTML files shat should be inserted after the pages created by sphinx.
253+
# The format is a list of tuples containing the path and title.
254+
#epub_post_files = []
255+
256+
# A list of files that should not be packed into the epub file.
257+
#epub_exclude_files = []
258+
259+
# The depth of the table of contents in toc.ncx.
260+
#epub_tocdepth = 3
261+
262+
# Allow duplicate toc entries.
263+
#epub_tocdup = True

0 commit comments

Comments
 (0)