From b73404484ccfc454bb76b66d311e4fd477b7cd04 Mon Sep 17 00:00:00 2001 From: Thierry Carrez Date: Tue, 28 Nov 2017 15:05:24 +0100 Subject: [PATCH] Set up initial content Initial content for the SIG website, including information on the Meta SIG. Change-Id: I92741f1d166e31c1c976f33d2de432111975aa6c --- .gitignore | 7 + README.rst | 1 + doc/source/_exts/teamtable.py | 140 +++++++++++++++ doc/source/_static/.placeholder | 0 doc/source/conf.py | 297 ++++++++++++++++++++++++++++++++ doc/source/index.rst | 13 ++ requirements.txt | 4 + setup.cfg | 17 ++ setup.py | 22 +++ sigs.yaml | 16 ++ test-requirements.txt | 7 + tox.ini | 16 ++ 12 files changed, 540 insertions(+) create mode 100644 .gitignore create mode 100644 README.rst create mode 100644 doc/source/_exts/teamtable.py create mode 100644 doc/source/_static/.placeholder create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 sigs.yaml create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ffc3261 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.tox +doc/build +*.egg-info +pbr*.egg +*.pyc +AUTHORS +ChangeLog diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b72fbca --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +This repository contains information about OpenStack SIGs. diff --git a/doc/source/_exts/teamtable.py b/doc/source/_exts/teamtable.py new file mode 100644 index 0000000..637adcc --- /dev/null +++ b/doc/source/_exts/teamtable.py @@ -0,0 +1,140 @@ +#!/usr/bin/env python + +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""Build a table of the current teams +""" + +from docutils import nodes +from docutils.parsers.rst.directives.tables import Table +from docutils.parsers.rst import directives + +import yaml + + +class TeamTable(Table): + """Insert the members table using the referenced file as source. + """ + HEADERS = ('Name', 'Chairs', 'Scope') + + option_spec = {'class': directives.class_option, + 'name': directives.unchanged, + 'datafile': directives.unchanged, + 'headers': directives.unchanged, + } + def run(self): + env = self.state.document.settings.env + app = env.app + + if self.options.get('headers') is not None: + self.HEADERS = self.options.get('headers').split(",") + # The required argument to the directive is the name of the + # file to parse. + datafile = self.options.get('datafile') + if not datafile: + error = self.state_machine.reporter.error( + 'No filename in teamtable directive', + nodes.literal_block(self.block_text, self.block_text), + line=self.lineno) + return [error] + + # Handle the width settings and title + try: + # Since docutils 0.13, get_column_widths returns a (widths, + # colwidths) tuple, where widths is a string (i.e. 'auto'). + # See https://sourceforge.net/p/docutils/patches/120/. + col_widths = self.get_column_widths(len(self.HEADERS)) + title, messages = self.make_title() + except SystemMessagePropagation as detail: + return [detail.args[0]] + except Exception as err: + error = self.state_machine.reporter.error( + 'Error processing memberstable directive:\n%s' % err, + nodes.literal_block(self.block_text, self.block_text), + line=self.lineno, + ) + return [error] + + # Now find the real path to the file, relative to where we are. + rel_filename, filename = env.relfn2path(datafile) + + app.info('loading teamtable') + app.info('reading %s' % filename) + with open(filename, 'r') as f: + _teams_yaml = yaml.load(f.read()) + + table = nodes.table() + + # Set up the column specifications + # based on the widths. + tgroup = nodes.tgroup(cols=len(self.HEADERS)) + table += tgroup + tgroup.extend(nodes.colspec(colwidth=col_width) + for col_width in col_widths) + + # Set the headers + thead = nodes.thead() + tgroup += thead + row_node = nodes.row() + thead += row_node + row_node.extend( + nodes.entry(h, nodes.paragraph(text=h)) + for h in self.HEADERS + ) + + # The body of the table is made up of rows. + # Each row contains a series of entries, + # and each entry contains a paragraph of text. + tbody = nodes.tbody() + tgroup += tbody + rows = [] + + all_teams = _teams_yaml + for team in sorted(all_teams.keys()): + trow = nodes.row() + # Iterate over the headers in the same order every time. + for h in self.HEADERS: + if h.lower() == "name": + cell = "%s" % (all_teams[team]['url'], team) + entry = nodes.entry() + para = nodes.raw('', cell, format='html') + elif h.lower() == "chairs": + chairs = [] + for chair in all_teams[team]['chairs']: + chairs.append("%s
" % (chair['name'])) + cell = "".join(chairs) + entry = nodes.entry() + para = nodes.raw('', cell, format='html') + else: + # Get the cell value from the row data, replacing None + # in re match group with empty string. + cell = all_teams[team][h.lower()] or '' + entry = nodes.entry() + para = nodes.paragraph(text=str(cell)) + entry += para + trow += entry + rows.append(trow) + tbody.extend(rows) + + # Build the table node + table['classes'] += self.options.get('class', []) + self.add_name(table) + + if title: + table.insert(0, title) + + return [table] + messages + + +def setup(app): + app.add_directive('teamtable', TeamTable) diff --git a/doc/source/_static/.placeholder b/doc/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..ef57c8b --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,297 @@ +# -*- coding: utf-8 -*- +# +# Tempest documentation build configuration file, created by +# sphinx-quickstart on Tue May 21 17:43:32 2013. +# +# 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. + +import sys +import os + +# 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.join(os.path.abspath('.'), '_exts')) + +# -- 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 = [ + 'sphinx.ext.extlinks', + 'oslosphinx', + 'teamtable', +] + +todo_include_todos = True + +# Define shorthand roles for making links to common destinations. +extlinks = { + 'repo': ('http://git.openstack.org/cgit/%s', ''), +} + +# 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' + +# General information about the project. +project = u'OpenStack SIG Governance' +copyright = u'2017, OpenStack Meta SIG' + +# 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 = ['_build'] + +# 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 = False + +# 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 = [] + + +# -- 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 = 'nature' + +# 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'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1" +html_last_updated_fmt = os.popen(git_cmd).read() + +# 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 = False + +# If false, no index is generated. +html_use_index = False + +# 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 = 'Tempestdoc' + + +# -- 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]). +latex_documents = [ + ('index', 'Governance.tex', u'OpenStack Governance Documents', + u'OpenStack Meta SIG', '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 = [ +] + +# 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', 'Governance', u'OpenStack Governance Documents', + u'OpenStack Meta SIG', 'Governance', 'One line description of project.', + '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' + + +# -- Options for Epub output +# --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'OpenStack SIG Governance' +epub_author = u'OpenStack Meta SIG' +epub_publisher = u'OpenStack Meta SIG' +epub_copyright = u'2017, OpenStack Meta SIG' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..f24a09f --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,13 @@ +================ + OpenStack SIGs +================ + +The OpenStack SIGs (Special Interest Groups) are a form of +working group in OpenStack that is an emanation of the community +as a whole and is not directly tied to a specific governance body. + +Existing SIGs +============= + +.. teamtable:: + :datafile: ../../sigs.yaml diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..a3f15ae --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +PyYAML>=3.1.0 # MIT diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..c63af29 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,17 @@ +[metadata] +name = openstack-governance-sigs +version = 2014.1 +summary = OpenStack SIGs Documents +description-file = + README.rst +author = OpenStack Meta SIG +author-email = openstack-sigs@lists.openstack.org +home-page = http://www.openstack.org/ + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source + +[pbr] +warnerrors = True diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..70c2b3f --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/sigs.yaml b/sigs.yaml new file mode 100644 index 0000000..5e230c0 --- /dev/null +++ b/sigs.yaml @@ -0,0 +1,16 @@ +Meta: + chairs: + - name: Melvin Hillsman + irc: mrhillsman + email: melvin.hillsman@huawei.com + - name: Thierry Carrez + irc: ttx + email: thierry@openstack.org + scope: > + A SIG for SIGs so to speak. A SIG to discuss OpenStack SIGs themselves, + to encourage workgroups to become SIGs, accompany them along the way, + give them tools and processes to be efficient. More generally, this SIG + will discuss how to best close the loop between users and developers of + OpenStack. + status: active + url: https://governance.openstack.org/sigs diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..40bcba4 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,7 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +# needed for doc build +docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain +sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD +oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..d16e0f4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,16 @@ +[tox] +envlist = docs +minversion = 1.6 +skipsdist = True + +[testenv] +usedevelop = True +install_command = pip install -U {opts} {packages} +setenv = VIRTUAL_ENV={envdir} +deps = -r{toxinidir}/test-requirements.txt + +[testenv:venv] +commands = {posargs} + +[testenv:docs] +commands = python setup.py build_sphinx