Package list python-castellan / 5d946f0
Add releasenotes for castellan Change-Id: I668815f3b353e15b72b88a62ea098fef66a94ae0 Jeremy Liu 4 years ago
9 changed file(s) with 304 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
4747
4848 # Sphinx
4949 doc/build
50 releasenotes/build
5051
5152 # pbr generates these
5253 AUTHORS
0 # -*- coding: utf-8 -*-
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
23 # If extensions (or modules to document with autodoc) are in another directory,
24 # add these directories to sys.path here. If the directory is relative to the
25 # documentation root, use os.path.abspath to make it absolute, like shown here.
26 # sys.path.insert(0, os.path.abspath('.'))
27
28 # -- General configuration ------------------------------------------------
29
30 # If your documentation needs a minimal Sphinx version, state it here.
31 # needs_sphinx = '1.0'
32
33 # Add any Sphinx extension module names here, as strings. They can be
34 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35 # ones.
36 extensions = [
37 'openstackdocstheme',
38 'reno.sphinxext',
39 ]
40
41 # Add any paths that contain templates here, relative to this directory.
42 templates_path = ['_templates']
43
44 # The suffix of source filenames.
45 source_suffix = '.rst'
46
47 # The encoding of source files.
48 # source_encoding = 'utf-8-sig'
49
50 # The master toctree document.
51 master_doc = 'index'
52
53 # General information about the project.
54 repository_name = 'openstack/castellan'
55 bug_project = 'castellan'
56 bug_tag = 'doc'
57 project = u'Castellan Release Notes'
58 copyright = u'2017, Castellan Developers'
59
60 # The version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
62 # built documents.
63 #
64 # The short X.Y version.
65 from pbr import version as pbr_version
66 # The full version, including alpha/beta/rc tags.
67 release = pbr_version.VersionInfo('castellan').version_string_with_vcs()
68 # The short X.Y version.
69 version = pbr_version.VersionInfo('castellan').canonical_version_string()
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 = 'openstackdocs'
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 = '%Y-%m-%d %H:%M'
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 = 'CastellanReleaseNotesdoc'
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', 'CastellanReleaseNotes.tex',
213 u'Castellan Release Notes Documentation',
214 u'Castellan Developers', 'manual'),
215 ]
216
217 # The name of an image file (relative to this directory) to place at the top of
218 # the title page.
219 # latex_logo = None
220
221 # For "manual" documents, if this is true, then toplevel headings are parts,
222 # not chapters.
223 # latex_use_parts = False
224
225 # If true, show page references after internal links.
226 # latex_show_pagerefs = False
227
228 # If true, show URL addresses after external links.
229 # latex_show_urls = False
230
231 # Documents to append as an appendix to all manuals.
232 # latex_appendices = []
233
234 # If false, no module index is generated.
235 # latex_domain_indices = True
236
237
238 # -- Options for manual page output ---------------------------------------
239
240 # One entry per manual page. List of tuples
241 # (source start file, name, description, authors, manual section).
242 man_pages = [
243 ('index', 'castellanreleasenotes',
244 u'Castellan Release Notes Documentation',
245 [u'Castellan Developers'], 1)
246 ]
247
248 # If true, show URL addresses after external links.
249 # man_show_urls = False
250
251
252 # -- Options for Texinfo output -------------------------------------------
253
254 # Grouping the document tree into Texinfo files. List of tuples
255 # (source start file, target name, title, author,
256 # dir menu entry, description, category)
257 texinfo_documents = [
258 ('index', 'CastellanReleaseNotes',
259 u'Castellan Release Notes Documentation',
260 u'Castellan Developers', 'CastellanReleaseNotes',
261 'One line description of project.',
262 'Miscellaneous'),
263 ]
264
265 # Documents to append as an appendix to all manuals.
266 # texinfo_appendices = []
267
268 # If false, no module index is generated.
269 # texinfo_domain_indices = True
270
271 # How to display URL addresses: 'footnote', 'no', or 'inline'.
272 # texinfo_show_urls = 'footnote'
273
274 # If true, do not generate a @detailmenu in the "Top" node's menu.
275 # texinfo_no_detailmenu = False
276
277 # -- Options for Internationalization output ------------------------------
278 locale_dirs = ['locale/']
0 =========================
1 Castellan Release Notes
2 =========================
3
4 .. toctree::
5 :maxdepth: 1
6
7 unreleased
8 pike
0 ===================================
1 Pike Series Release Notes
2 ===================================
3
4 .. release-notes::
5 :branch: stable/pike
0 ==============================
1 Current Series Release Notes
2 ==============================
3
4 .. release-notes::
1212 testscenarios>=0.4 # Apache-2.0/BSD
1313 testtools>=1.4.0 # MIT
1414 bandit>=1.1.0 # Apache-2.0
15 reno>=2.5.0 # Apache-2.0
4343 [testenv:docs]
4444 commands = python setup.py build_sphinx
4545
46 [testenv:releasenotes]
47 commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
48
4649 [testenv:functional]
4750 usedevelop = True
4851 install_command = pip install -U {opts} {packages}