From f6ed6f5843ae15cf6f820e5b11769996ec45cfc7 Mon Sep 17 00:00:00 2001 From: Davlet Panech Date: Tue, 14 Apr 2020 11:15:44 -0400 Subject: [PATCH] Added .gitreview, .zuul.yaml & tox.ini Change-Id: Iafefaf07617a75b8ec2ba62bc98df2cd33c5c29e Signed-off-by: Davlet Panech --- .gitignore | 2 + .gitreview | 4 + .zuul.yaml | 106 +++++++ doc/requirements.txt | 5 + doc/source/conf.py | 163 +++++++++++ doc/source/index.rst | 26 ++ ...se-summary-stx201810-1c828b5648cd37c4.yaml | 3 + releasenotes/source/conf.py | 259 ++++++++++++++++++ releasenotes/source/index.rst | 8 + releasenotes/source/unreleased.rst | 5 + test-requirements.txt | 3 + tox.ini | 64 +++++ 12 files changed, 648 insertions(+) create mode 100644 .gitignore create mode 100644 .gitreview create mode 100644 .zuul.yaml create mode 100644 doc/requirements.txt create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 100644 releasenotes/notes/release-summary-stx201810-1c828b5648cd37c4.yaml create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/index.rst create mode 100644 releasenotes/source/unreleased.rst create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..8fc05ab6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.swp +.tox diff --git a/.gitreview b/.gitreview new file mode 100644 index 00000000..f058e259 --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.opendev.org +port=29418 +project=starlingx/kernel.git diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 00000000..a6cdb5f0 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,106 @@ +--- +- project: + templates: + - publish-stx-docs + - stx-release-notes-jobs + check: + jobs: + - openstack-tox-linters + gate: + jobs: + - openstack-tox-linters + post: + jobs: + - stx-kernel-upload-git-mirror + +- job: + name: stx-kernel-upload-git-mirror + parent: upload-git-mirror + description: > + Mirrors opendev.org/starlingx/kernel to + github.com/starlingx/kernel + vars: + git_mirror_repository: starlingx/kernel + secrets: + - name: git_mirror_credentials + secret: stx-kernel-github-secret + pass-to-parent: true + +- secret: + name: stx-kernel-github-secret + data: + user: git + host: github.com + # yamllint disable-line rule:line-length + host_key: github.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ== + ssh_key: !encrypted/pkcs1-oaep + - AIhIuSw1YHgR7gQQtkh5LriWc6Jv2xfd7GWrRSmLiDOYRN2HcEtsAv+EQkY1y3OcZgMNU + xmn0bcahYqc6KC+08nbWHcK5lqZSwJ1XZcm/Lr3BS5zWNIKHB68F757tv4B5HM2BhQHwC + f53EIvaLOy16jhpaJJ5XSY/DNUPT+3mlO+Z6+BPdVg3vPKJrXK9jjtA/QSmKWgGsQH64c + 8Cce4Yg6UpQfX7Ht1H9Cr+L1ErqeQSb2BjFkC6Ez2ibWfh6eC74dAC+JYEbN03roJU4Oj + 20g57qKDdcaL10UlVz94TnW5uOsIDNTF23a7hoYEwtvr3lDAv6pP+JMjnjypPbGOC8UMP + WzwmKZffWCCOlxm+SUZu+Z/RVj3yZtjqU8N+jHmVgZF0LY+iAaRQebHeTLt6j/0IJHTw8 + PdFAqgsjdxUdvckyu+1u+zu9j5f4B2+HRLqEtuDI6a1FCLnGhhcDgRzj5MyiAh7JTqRWW + xh/dJRtHZJgpJuOPasb93gUNjjdBm620m5eO6WbgjiyG3SFfL98D3F7jp+KFj6a+W436I + 5iBj/AxAXTtetT1pLHlcAXfx1g2ybJzp3f37RHTiUZ4ZJDFfCSmpZkT19vSP578C8kLdv + P8HQC2qid2pB/5H+5WKKnPl/0E5yYOaGvEo3TQQtN/PLKkrDrMdVoyTcfxmlfI= + - PSsWJhtO/Vgmh16p6AtLR/8yg3c0StQHdPTtVfrpgc8eN0iQENdnaAMbbRHUXPfRffMvS + UWU3Es3FCba/Lev8x6kYMiXwo1p9gx/Li8qcw5DcLy/Rmcr+OZS/HSA3d1A2jfeR022mL + esYZeB6Bd7ryQtvZCxUsiT/mKGnDw5jgM2G5K4HcwJtNuimqtB7JzLsMjKwfM6SIdH3iR + sLteoxr+B+rKsgV5RnUKBBlzFcojxCKhN5vXZkNV5nlmBKvhVTh+txyKNBfo1JgREvHBy + pJVryuaF8bwH4FN0ZzVWDJXIXsaDLHUVs7gwtgtXZRrCMFObt6aVyyQXJbp6Q2Qw48cGG + xQ2JJzK3UnBCF8ooFdrkyLlA0rmzPHUotzoUT3bLMY675wqsf3DMcL59zp8bB8bkkxdWI + arrU3EZliF5+zf5JlS4h17bRMPxkaBZRegCkRdNBrMgcjNxUTkPpQ48oSB6Ki0e/PjDkT + /ZaTqpmZv4Sv3waBtjLe/fCVbApp+mlKfn0AUB89b7p0VsAOdVnxTMa1DcTUS/ELmvbc4 + 6xheEdvIlM1KQRGWIy82/IfvM7Y71qrDNJadh8Mi346V+WKgt3XdosnIPywLxi77eYVKC + oiW1VL0zwk1IKpgOeCXZdKssaCA+T6VuFLzYZOCFQsUrzHs4hPYdxIGz9TDu+s= + - BnVIvJiiBVcUxDt6UDmYZ9gPbwr+gsOIv7DUCmlgP2+wM3FfsQ3zDanuvEk6rDYH2W8Np + i/EmPu9/7hAQdKlSfdcqCccQqI/4pYvP1Mu8xBCYD2vqzze5BFGXE1G1ppxSzfnLVZVCu + RROgc6hn9XlTVkBVDR1HOLUO5KlHiRY9GQA3jMRxR+Qe7N8vMluQgEByWEYRjiz/Q5Pry + 7PWuyBON+8WFNy4g7DfkghhkEh1RSw49ZqJcDi0IAfiVCOFbTjtQYjQu1VTk1W9oZ0AQf + 7fidgTjSRMMqC39xI8dK2okIQnCLOneqJ87J9tzXXVMWGja/54aYDhE/54UnlKfp/3IVA + zyHsX5LXqcBnhzute/B/ANLge9yW/x4dcz4hRFPFAC2rItROpQjlBjJdVC2RB0NnuFfIA + gErGyblw9HWkLUJUBaX06Pn7GIPI2vnJCOjqjBcZiLYHT4I+YQbe+z+IMC8Y2CAKdXEg+ + jxRhK9ywL88ykQKii44jPGprd0w6CN/LYw0zB7gs+7lyLuHieT88ClvFCKjg6PkWR9I84 + U4Y0uBwZNyPupImX1Sxl95u28mMivsbQaIBQMl2qLNLmo9FAIGHVa254wKw2Vo+L7Mtx7 + IkoEwssxgbJOLhUE2jhauuVJga7NHwNa5PZbcz3hpTWQBdKWxGrJ+Q4lQsltdE= + - G6mzbGYWv7Ur8xc6KA3c0YedPPIleeKCbdwpcH7Ln545ep4GXRE2AzEuq0rtO6n7ImIV4 + /R1/eBSRCJFbwBckZ8CSre4YEXkxs2kc80bzn5foquCWCkvJMiogmLtSKp9VmW22wMdO0 + b6K2/5czLzhFGcPOYsNJLb793fWCx1WJ3dGJaxwqHAQR7NTfhMRcXWYGX5dDwwhbwdkHZ + JEPrlHzmYWRGLJjhQuDquNVvwpGf94hPFCZ0VhyS8W8lTmpcqd8Sg3pDbl4A+zADS78Lo + 8SrOFtU4EsF86+703mxvoJ7U6HNdAqvWAmtY5fF404ZJuiBI/D5XEcc5jdY51d2+QI+Gu + 71ceHG83S4erbodP7+oT/K2xZt7Q8HyeaRib93GrJhEHrlpvF1NxjE877FFRzskUyS4Kq + c7HiseRv4qtYY/ztxPtOx+CousOejGuvnP8NKquh6jev7u9Gm6Fbx+v/f+lkIyEAN6u+e + Zwo0hL6G/ttv/QPa0iofbc4SBN+yL0knPVDC68UrmMb64nsmSpywbkqYv4/s9jhymeniT + HkIkmUQfYTb0FFz+rGy4L7xAER6OUwCp4kW9xHAtYX9KsqA8A8mCDgWncQxEM0UhYhjfn + DKBzWr6vhrkn9hJhSFmhoE49e9W2fIXnkH9h13h6myNkIrtRX1JWBakOfM/EEM= + - s07UtTQzSeZ1QXEio3uSxzcD71ocXQQvLMAtEulozIDsYrLPJiQXfajXX9QX0aBgg1MtY + nxJ1QNiXOflZFD5lqciyekCHdPnsN52iZUzIf1TMVfNT9oCmr1CVsKwMLJWLEuXZJI8SY + VHH1Fn0JmKPoD2WgrbopqpKYtgO8CSSPbNb8GVrRF22RUTgrPJOw/myMC4jy15jJCvpbh + h091f7oe7yaIFg3KowO2yGVxhhd1N/TOHLaeG3XRQUs4TX5i6bWuAtsF0NfPO0C4/GuwC + xwAFjjaNa39rR5eHEEMxjJ18vnFE++iwi8qdDsQyYzds6T5fCPlJb1VMd4vq04oONLWLx + tgNJVwslNi8GFTjYDQW/4c/gIVxNTJmUt6YC2VvVZIQUQiRKic+ITmppk4IDYsVXTOj6E + pmNmmUXltXvVppmX7p4jv2lLIdAXaWkXjw5S5udTEuIJKWN1z2lIAY3pGDTwYlLY8wN5x + hOG3Dir1sn/PaCsUbbG6nCdGp213C2qx+pLsXMQv46QA+Qo4Rg4ILoYG/xffr9Q7b51cB + Z8WzwBZ3Clmkd8ysXHewP1ccBXqnsJD+peZSDZFAe7SXCBErx00ULmF+TDMFZNpXFRxXn + tO8v8s+ZFtDDa/BU8+MVByvUKSNz4acCfCZHK+Z1B9iLsruit9vSe34DVXp5HY= + - WPa9SzMvIojVdh5Cyd3EJznbGQiPuR4Jmyualn4BtC1Tg5kEURIALCwn0STopoTTxSdvT + JZIacl+t7lPGSidRc+TMUSFaEC3RNN/FttqAgt1WAx4c93Gb1HaN6JIPRJ2DtPtr7wC0V + mKsZ+0clI15y3fjQXBnqzhFo5ogHOvfZghGjaBwnKmOJoXpqkl7V7qcWJ38YlU4svI/k9 + 4NfXSuseesc5Pf3kdr5yCf+71p5HtAYPAqNxUR4zhxIBFQeZRjatinWDSDNuFKwnIGJbS + JCw6rzZtywKf4saDoSrE1jaO5a7LsFr4jBVMMV3CAZB8L+DvRbsxL9jzqivkEI74SO2lo + In77oAtqahJKWfnBYIjEsX+lD1Qs2yUWK4tdKycF1Umxb9s8+Oc/NXA9lzvAGjwIYVlMT + fGjDHHHC831rFV8TrMiGxATQysPrMQYk8RQkklNbijMg2CxlaR1vXNQcCft6Botu98wTl + 5rgzC/J1tqZZXLe68/wcpLBqOhjWOG/glTF9tZywjP9JX9MgBrGKNBcW57t9QyZgXDmnm + oFR8fjH8d4HG75etHPl0hsoZlo3qhe86OlXRMy3e9D4tUS7rEfY3Pd/TvJojeFsPS9DWk + nbaRo9s3+eL2NaMLAIKp9ZM5MVSlBpC+QiF+iZNHXzPFDiCCYxZxKdXNlNgj1Y= + - ZiK3jjLtTZ4vd/uaTjs3j3UoMLra81rP9WelgBE2j/Vzm8/Jv3hEp1g4gQuPs5PIgtUNp + pL/26ORAK/B2o1vAHQU2gHtY6hjzms8REuz3sMc/INR0ry1PhP1jlUZkGSqjsoQ71GGCJ + SlA+wVOlLna880GOhf1xs+sC8ibxScDDHEoHipPh3WW90M6rw6fBnATIjj2MkRNFuxfZN + Kz5ASxzWLyV1ICLDwbkF1z/RH5D1zIurP5QsRN3q9hMgqOumC9F+UZvFuSxMHHSFJX0BV + Dh/tPWdl3zIi0UH9LMrtxYEPte9EGHBP3G1kVTVrMsF6VPZhtA8C0jgqbU+JCOvln5dni + t2bHRG8hME6sQuseUofUPPyntP0RvY03kOvXjs6ZMm/gmyrBGyEjYpFOLkpE5a9juqWg4 + EvcqIyN1mWFcxJ01kSQS7HKbrtmacq/SDjcTqi8yjBSbzbV6t0Mio0Y9g7V/U9utaubps + jD9tUFBfCinC8v9yu5dkLwHFqEBfXDS5XV64J06L6ah5lbzt6fZ1no67Ub/6Mp3OAqEf1 + nlwYi5CzaLyn+7WX7REaWfkueAnOahEpQKMwxwIMwqeOqFEOSxMW5OGbEaj3/gALtD8/3 + B67Tqd+xc8MfvIlNs/9OWbMzRHKXDL+fUORb20dRecamfE9rdm9ep31w5/akfM= diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..3a7529d3 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +sphinx>=1.6.2 +openstackdocstheme>=1.26.0 # Apache-2.0 + +# Release Notes documentation +reno>=0.1.1 # Apache2 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 00000000..6199f917 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,163 @@ +# -*- coding: utf-8 -*- +# +# SPDX-License-Identifier: Apache-2.0 + +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another +# directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown +# here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = u'StarlingX Linux Kernel' +copyright = u'2020, StarlingX' +author = u'StarlingX' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'0.1' + + +# -- 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 = [ + 'openstackdocstheme', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# 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' + +bug_project = '1027' +bug_tag = 'stx.bug' + +# 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 pattern also affects html_static_path and html_extra_path . +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- 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 = 'starlingxdocs' + +# 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'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'stx-kerneldoc' + + +# -- 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, 'stx-kernel.tex', u'stx-kernel Documentation', + u'StarlingX', '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, 'stx-kernel', u'stx-kernel 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, 'stx-kernel', u'stx-kernel Documentation', + author, 'stx-kernel', 'StarlingX Linux Kernel.', + 'Miscellaneous'), +] diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 00000000..a87ffa8a --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,26 @@ +=================================== +StarlingX Kernel Project +=================================== + +The starlingx/kernel project provides the Linux kernel for StarlingX. + +------------- +Release notes +------------- + +.. toctree:: + :maxdepth: 1 + + Release notes + +----- +Links +----- + +* Source: `starlingx/kernel`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ + +.. _starlingx/kernel: https://opendev.org/starlingx/kernel +.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/kernel +.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/kernel diff --git a/releasenotes/notes/release-summary-stx201810-1c828b5648cd37c4.yaml b/releasenotes/notes/release-summary-stx201810-1c828b5648cd37c4.yaml new file mode 100644 index 00000000..1612476a --- /dev/null +++ b/releasenotes/notes/release-summary-stx201810-1c828b5648cd37c4.yaml @@ -0,0 +1,3 @@ +--- +prelude: > + The initial community release of StarlingX diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 00000000..4f9509c1 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,259 @@ +# -*- coding: utf-8 -*- +# +# SPDX-License-Identifier: Apache-2.0 + +# stx-integ Release Notes documentation build configuration file. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- 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 = [ + 'openstackdocstheme', + 'reno.sphinxext', +] + +bug_project = '1027' +bug_tag = 'stx.bug' + +# Add any paths that contain templates here, relative to this directory. +# templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +project = u'StarlingX Linux Kernel' + +# Release notes are version independent, no need to set version and release +release = '' +version = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = 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 = 'starlingxdocs' + +# 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 themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# 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' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'stx-kernelreleasenotesdoc' + + +# -- 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': '', +} + +# 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 = [ + ('index', 'stx-kernelreleasenotes.tex', u'stx-kernel Release Notes', + u'StarlingX', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'stx-kernelreleasenotes', u'stx-kernel Release Notes', + [u'StarlingX'], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- 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 = [ + ('index', 'stx-kernelReleaseNotes', u'stx-kernel Release Notes', + u'StarlingX', 'stx-kernelreleasenotes', + 'StarlingX Linux Kernel', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 00000000..d2bf6be1 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,8 @@ +=================================== +StarlingX Kernel Release Notes +=================================== + +.. toctree:: + :maxdepth: 2 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 00000000..875030f9 --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================ +Current Series Release Notes +============================ + +.. release-notes:: diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 00000000..47d1aec2 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,3 @@ +bashate >= 0.2 +PyYAML >= 3.1.0 +yamllint >= 0.5.2 diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..545c7cb3 --- /dev/null +++ b/tox.ini @@ -0,0 +1,64 @@ +[tox] +envlist = linters +minversion = 2.3 +skipsdist = True +stxdir = {toxinidir}/.. + +[testenv] +install_command = pip install -U \ + -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/stable/stein/upper-constraints.txt} \ + {opts} {packages} +setenv = VIRTUAL_ENV={envdir} + OS_STDOUT_CAPTURE=1 + OS_STDERR_CAPTURE=1 + OS_TEST_TIMEOUT=60 +deps = -r{toxinidir}/test-requirements.txt +whitelist_externals = reno + +[testenv:linters] +basepython = python3 +whitelist_externals = bash +#bashate ignore +#E006 Line too long +commands = + bash -c "find {toxinidir} \ + -not \( -type d -name .?\* -prune \) \ + -type f \ + -not -name \*~ \ + -not -name \*.md \ + -name \*.sh \ + -print0 | xargs -r -n 1 -0 bashate -v \ + -i E006 -e E*" + bash -c "find {toxinidir} \ + \( -path {toxinidir}/.tox \) -a -prune \ + -o -type f -name '*.yaml' \ + -print0 | xargs -r -0 yamllint" + +[testenv:venv] +basepython = python3 +commands = {posargs} + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt +commands = + rm -rf doc/build + sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html +whitelist_externals = rm + +[testenv:releasenotes] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt +commands = + rm -rf releasenotes/build + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html +whitelist_externals = rm + rm + +[testenv:newnote] +basepython = python3 +# Re-use the releasenotes venv +envdir = {toxworkdir}/releasenotes +deps = -r{toxinidir}/doc/requirements.txt +commands = reno new {posargs} +