diff --git a/releasenotes/notes/basic-framework-28d6b42d9bf684af.yaml b/releasenote/notes/basic-framework-28d6b42d9bf684af.yaml similarity index 100% rename from releasenotes/notes/basic-framework-28d6b42d9bf684af.yaml rename to releasenote/notes/basic-framework-28d6b42d9bf684af.yaml diff --git a/releasenotes/notes/cyborg-nova-interaction-8fe4e49e3c9b3b7b.yaml b/releasenote/notes/cyborg-nova-interaction-8fe4e49e3c9b3b7b.yaml similarity index 100% rename from releasenotes/notes/cyborg-nova-interaction-8fe4e49e3c9b3b7b.yaml rename to releasenote/notes/cyborg-nova-interaction-8fe4e49e3c9b3b7b.yaml diff --git a/releasenotes/notes/fpga-driver-8b1635e92b1297c1.yaml b/releasenote/notes/fpga-driver-8b1635e92b1297c1.yaml similarity index 100% rename from releasenotes/notes/fpga-driver-8b1635e92b1297c1.yaml rename to releasenote/notes/fpga-driver-8b1635e92b1297c1.yaml diff --git a/releasenotes/notes/generic-driver-88427acd7c7c12df.yaml b/releasenote/notes/generic-driver-88427acd7c7c12df.yaml similarity index 100% rename from releasenotes/notes/generic-driver-88427acd7c7c12df.yaml rename to releasenote/notes/generic-driver-88427acd7c7c12df.yaml diff --git a/releasenotes/notes/spdk-driver-89b178e1a2db29c0.yaml b/releasenote/notes/spdk-driver-89b178e1a2db29c0.yaml similarity index 100% rename from releasenotes/notes/spdk-driver-89b178e1a2db29c0.yaml rename to releasenote/notes/spdk-driver-89b178e1a2db29c0.yaml diff --git a/releasenote/source/conf.py b/releasenote/source/conf.py new file mode 100644 index 00000000..d7400c49 --- /dev/null +++ b/releasenote/source/conf.py @@ -0,0 +1,152 @@ +# -*- coding: utf-8 -*- + +# -- 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. +extensions = [ + 'reno.sphinxext', + 'openstackdocstheme', +] + +# openstackdocstheme options +repository_name = 'openstack/cyborg' +bug_project = 'openstack-cyborg' +bug_tag = '' + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Cyborg Release Notes' +copyright = u'2018, Cyborg developers' +author = u'cyborg developers' + +# 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 = "" +# The full version, including alpha/beta/rc tags. +release = "" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = 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 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 = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +# html_sidebars = {} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'CyborgReleaseNotesdoc' + + +# -- 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': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# 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 = [ + (master_doc, 'CyborgReleaseNotes.tex', + u'Cyborg Release Notes Documentation', + u'Cyborg developers', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'CyborgReleaseNotes', u'Cyborg Release Notes Documentation', + [author], 1) +] + + +# -- 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 = [ + (master_doc, 'CyborgReleaseNotes', u'Cyborg Release Notes Documentation', + author, 'CyborgReleaseNotes', 'One line description of project.', + 'Miscellaneous'), +] + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenote/source/index.rst b/releasenote/source/index.rst new file mode 100644 index 00000000..f063849d --- /dev/null +++ b/releasenote/source/index.rst @@ -0,0 +1,14 @@ +Welcome to Cyborg Release Notes documentation! +================================== + +.. toctree:: + :maxdepth: 2 + + unreleased + queens + + +Indices and tables +================== + +* :ref:`search` diff --git a/releasenote/source/queens.rst b/releasenote/source/queens.rst new file mode 100644 index 00000000..36ac6160 --- /dev/null +++ b/releasenote/source/queens.rst @@ -0,0 +1,6 @@ +=================================== + Queens Series Release Notes +=================================== + +.. release-notes:: + :branch: stable/queens diff --git a/releasenote/source/unreleased.rst b/releasenote/source/unreleased.rst new file mode 100644 index 00000000..875030f9 --- /dev/null +++ b/releasenote/source/unreleased.rst @@ -0,0 +1,5 @@ +============================ +Current Series Release Notes +============================ + +.. release-notes:: diff --git a/tox.ini b/tox.ini index 87173681..31d6a04d 100644 --- a/tox.ini +++ b/tox.ini @@ -47,6 +47,9 @@ commands = python setup.py build_sphinx oslo-config-generator --config-file=tools/config/cyborg-config-generator.conf +[testenv:releasenotes] +commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + [testenv:debug] commands = oslo_debug_helper -t cyborg/tests {posargs}