diff options
Diffstat (limited to 'releasenotes')
-rw-r--r-- | releasenotes/notes/.placeholder | 0 | ||||
-rw-r--r-- | releasenotes/source/_static/.placeholder | 0 | ||||
-rw-r--r-- | releasenotes/source/_templates/.placeholder | 0 | ||||
-rw-r--r-- | releasenotes/source/conf.py | 275 | ||||
-rw-r--r-- | releasenotes/source/index.rst | 8 | ||||
-rw-r--r-- | releasenotes/source/unreleased.rst | 5 |
6 files changed, 288 insertions, 0 deletions
diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/releasenotes/notes/.placeholder | |||
diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/releasenotes/source/_static/.placeholder | |||
diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/releasenotes/source/_templates/.placeholder | |||
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..2ad9acf --- /dev/null +++ b/releasenotes/source/conf.py | |||
@@ -0,0 +1,275 @@ | |||
1 | # -*- coding: utf-8 -*- | ||
2 | # Licensed under the Apache License, Version 2.0 (the "License"); | ||
3 | # you may not use this file except in compliance with the License. | ||
4 | # You may obtain a copy of the License at | ||
5 | # | ||
6 | # http://www.apache.org/licenses/LICENSE-2.0 | ||
7 | # | ||
8 | # Unless required by applicable law or agreed to in writing, software | ||
9 | # distributed under the License is distributed on an "AS IS" BASIS, | ||
10 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
11 | # implied. | ||
12 | # See the License for the specific language governing permissions and | ||
13 | # limitations under the License. | ||
14 | |||
15 | # Glance Release Notes documentation build configuration file, created by | ||
16 | # sphinx-quickstart on Tue Nov 3 17:40:50 2015. | ||
17 | # | ||
18 | # This file is execfile()d with the current directory set to its | ||
19 | # containing dir. | ||
20 | # | ||
21 | # Note that not all possible configuration values are present in this | ||
22 | # autogenerated file. | ||
23 | # | ||
24 | # All configuration values have a default; values that are commented out | ||
25 | # serve to show the default. | ||
26 | |||
27 | # If extensions (or modules to document with autodoc) are in another directory, | ||
28 | # add these directories to sys.path here. If the directory is relative to the | ||
29 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
30 | # sys.path.insert(0, os.path.abspath('.')) | ||
31 | |||
32 | # -- General configuration ------------------------------------------------ | ||
33 | |||
34 | # If your documentation needs a minimal Sphinx version, state it here. | ||
35 | # needs_sphinx = '1.0' | ||
36 | |||
37 | # Add any Sphinx extension module names here, as strings. They can be | ||
38 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
39 | # ones. | ||
40 | extensions = [ | ||
41 | 'oslosphinx', | ||
42 | 'reno.sphinxext', | ||
43 | ] | ||
44 | |||
45 | # Add any paths that contain templates here, relative to this directory. | ||
46 | templates_path = ['_templates'] | ||
47 | |||
48 | # The suffix of source filenames. | ||
49 | source_suffix = '.rst' | ||
50 | |||
51 | # The encoding of source files. | ||
52 | # source_encoding = 'utf-8-sig' | ||
53 | |||
54 | # The master toctree document. | ||
55 | master_doc = 'index' | ||
56 | |||
57 | # General information about the project. | ||
58 | project = u'ttrun Release Notes' | ||
59 | copyright = u'2016, OpenStack Foundation' | ||
60 | |||
61 | # The version info for the project you're documenting, acts as replacement for | ||
62 | # |version| and |release|, also used in various other places throughout the | ||
63 | # built documents. | ||
64 | # | ||
65 | # The short X.Y version. | ||
66 | # The full version, including alpha/beta/rc tags. | ||
67 | release = '' | ||
68 | # The short X.Y version. | ||
69 | version = '' | ||
70 | |||
71 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
72 | # for a list of supported languages. | ||
73 | # language = None | ||
74 | |||
75 | # There are two options for replacing |today|: either, you set today to some | ||
76 | # non-false value, then it is used: | ||
77 | # today = '' | ||
78 | # Else, today_fmt is used as the format for a strftime call. | ||
79 | # today_fmt = '%B %d, %Y' | ||
80 | |||
81 | # List of patterns, relative to source directory, that match files and | ||
82 | # directories to ignore when looking for source files. | ||
83 | exclude_patterns = [] | ||
84 | |||
85 | # The reST default role (used for this markup: `text`) to use for all | ||
86 | # documents. | ||
87 | # default_role = None | ||
88 | |||
89 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
90 | # add_function_parentheses = True | ||
91 | |||
92 | # If true, the current module name will be prepended to all description | ||
93 | # unit titles (such as .. function::). | ||
94 | # add_module_names = True | ||
95 | |||
96 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
97 | # output. They are ignored by default. | ||
98 | # show_authors = False | ||
99 | |||
100 | # The name of the Pygments (syntax highlighting) style to use. | ||
101 | pygments_style = 'sphinx' | ||
102 | |||
103 | # A list of ignored prefixes for module index sorting. | ||
104 | # modindex_common_prefix = [] | ||
105 | |||
106 | # If true, keep warnings as "system message" paragraphs in the built documents. | ||
107 | # keep_warnings = False | ||
108 | |||
109 | |||
110 | # -- Options for HTML output ---------------------------------------------- | ||
111 | |||
112 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
113 | # a list of builtin themes. | ||
114 | html_theme = 'default' | ||
115 | |||
116 | # Theme options are theme-specific and customize the look and feel of a theme | ||
117 | # further. For a list of options available for each theme, see the | ||
118 | # documentation. | ||
119 | # html_theme_options = {} | ||
120 | |||
121 | # Add any paths that contain custom themes here, relative to this directory. | ||
122 | # html_theme_path = [] | ||
123 | |||
124 | # The name for this set of Sphinx documents. If None, it defaults to | ||
125 | # "<project> v<release> documentation". | ||
126 | # html_title = None | ||
127 | |||
128 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
129 | # html_short_title = None | ||
130 | |||
131 | # The name of an image file (relative to this directory) to place at the top | ||
132 | # of the sidebar. | ||
133 | # html_logo = None | ||
134 | |||
135 | # The name of an image file (within the static path) to use as favicon of the | ||
136 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
137 | # pixels large. | ||
138 | # html_favicon = None | ||
139 | |||
140 | # Add any paths that contain custom static files (such as style sheets) here, | ||
141 | # relative to this directory. They are copied after the builtin static files, | ||
142 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
143 | html_static_path = ['_static'] | ||
144 | |||
145 | # Add any extra paths that contain custom files (such as robots.txt or | ||
146 | # .htaccess) here, relative to this directory. These files are copied | ||
147 | # directly to the root of the documentation. | ||
148 | # html_extra_path = [] | ||
149 | |||
150 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
151 | # using the given strftime format. | ||
152 | # html_last_updated_fmt = '%b %d, %Y' | ||
153 | |||
154 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
155 | # typographically correct entities. | ||
156 | # html_use_smartypants = True | ||
157 | |||
158 | # Custom sidebar templates, maps document names to template names. | ||
159 | # html_sidebars = {} | ||
160 | |||
161 | # Additional templates that should be rendered to pages, maps page names to | ||
162 | # template names. | ||
163 | # html_additional_pages = {} | ||
164 | |||
165 | # If false, no module index is generated. | ||
166 | # html_domain_indices = True | ||
167 | |||
168 | # If false, no index is generated. | ||
169 | # html_use_index = True | ||
170 | |||
171 | # If true, the index is split into individual pages for each letter. | ||
172 | # html_split_index = False | ||
173 | |||
174 | # If true, links to the reST sources are added to the pages. | ||
175 | # html_show_sourcelink = True | ||
176 | |||
177 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
178 | # html_show_sphinx = True | ||
179 | |||
180 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
181 | # html_show_copyright = True | ||
182 | |||
183 | # If true, an OpenSearch description file will be output, and all pages will | ||
184 | # contain a <link> tag referring to it. The value of this option must be the | ||
185 | # base URL from which the finished HTML is served. | ||
186 | # html_use_opensearch = '' | ||
187 | |||
188 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
189 | # html_file_suffix = None | ||
190 | |||
191 | # Output file base name for HTML help builder. | ||
192 | htmlhelp_basename = 'GlanceReleaseNotesdoc' | ||
193 | |||
194 | |||
195 | # -- Options for LaTeX output --------------------------------------------- | ||
196 | |||
197 | latex_elements = { | ||
198 | # The paper size ('letterpaper' or 'a4paper'). | ||
199 | # 'papersize': 'letterpaper', | ||
200 | |||
201 | # The font size ('10pt', '11pt' or '12pt'). | ||
202 | # 'pointsize': '10pt', | ||
203 | |||
204 | # Additional stuff for the LaTeX preamble. | ||
205 | # 'preamble': '', | ||
206 | } | ||
207 | |||
208 | # Grouping the document tree into LaTeX files. List of tuples | ||
209 | # (source start file, target name, title, | ||
210 | # author, documentclass [howto, manual, or own class]). | ||
211 | latex_documents = [ | ||
212 | ('index', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation', | ||
213 | u'Glance Developers', 'manual'), | ||
214 | ] | ||
215 | |||
216 | # The name of an image file (relative to this directory) to place at the top of | ||
217 | # the title page. | ||
218 | # latex_logo = None | ||
219 | |||
220 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
221 | # not chapters. | ||
222 | # latex_use_parts = False | ||
223 | |||
224 | # If true, show page references after internal links. | ||
225 | # latex_show_pagerefs = False | ||
226 | |||
227 | # If true, show URL addresses after external links. | ||
228 | # latex_show_urls = False | ||
229 | |||
230 | # Documents to append as an appendix to all manuals. | ||
231 | # latex_appendices = [] | ||
232 | |||
233 | # If false, no module index is generated. | ||
234 | # latex_domain_indices = True | ||
235 | |||
236 | |||
237 | # -- Options for manual page output --------------------------------------- | ||
238 | |||
239 | # One entry per manual page. List of tuples | ||
240 | # (source start file, name, description, authors, manual section). | ||
241 | man_pages = [ | ||
242 | ('index', 'glancereleasenotes', u'Glance Release Notes Documentation', | ||
243 | [u'Glance Developers'], 1) | ||
244 | ] | ||
245 | |||
246 | # If true, show URL addresses after external links. | ||
247 | # man_show_urls = False | ||
248 | |||
249 | |||
250 | # -- Options for Texinfo output ------------------------------------------- | ||
251 | |||
252 | # Grouping the document tree into Texinfo files. List of tuples | ||
253 | # (source start file, target name, title, author, | ||
254 | # dir menu entry, description, category) | ||
255 | texinfo_documents = [ | ||
256 | ('index', 'GlanceReleaseNotes', u'Glance Release Notes Documentation', | ||
257 | u'Glance Developers', 'GlanceReleaseNotes', | ||
258 | 'One line description of project.', | ||
259 | 'Miscellaneous'), | ||
260 | ] | ||
261 | |||
262 | # Documents to append as an appendix to all manuals. | ||
263 | # texinfo_appendices = [] | ||
264 | |||
265 | # If false, no module index is generated. | ||
266 | # texinfo_domain_indices = True | ||
267 | |||
268 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | ||
269 | # texinfo_show_urls = 'footnote' | ||
270 | |||
271 | # If true, do not generate a @detailmenu in the "Top" node's menu. | ||
272 | # texinfo_no_detailmenu = False | ||
273 | |||
274 | # -- Options for Internationalization output ------------------------------ | ||
275 | locale_dirs = ['locale/'] | ||
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000..10e409e --- /dev/null +++ b/releasenotes/source/index.rst | |||
@@ -0,0 +1,8 @@ | |||
1 | ============================================ | ||
2 | ttrun Release Notes | ||
3 | ============================================ | ||
4 | |||
5 | .. toctree:: | ||
6 | :maxdepth: 1 | ||
7 | |||
8 | unreleased | ||
diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..cd22aab --- /dev/null +++ b/releasenotes/source/unreleased.rst | |||
@@ -0,0 +1,5 @@ | |||
1 | ============================== | ||
2 | Current Series Release Notes | ||
3 | ============================== | ||
4 | |||
5 | .. release-notes:: | ||