83ba960797
Sphinx 1.6 deprecated using the application object to perform logging and it will be removed in the upcoming 2.0 release. This updates our extensions to use the recommended sphinx.util.logging instead. Change-Id: Ibf9f1c84171b73bb620f8df9a26ae97a8545b4b2 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
137 lines
4.4 KiB
Python
137 lines
4.4 KiB
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 members of the TC.
|
|
"""
|
|
|
|
from docutils import nodes
|
|
from docutils.parsers.rst import directives
|
|
from docutils.parsers.rst.directives import tables
|
|
from docutils.utils import SystemMessagePropagation
|
|
from sphinx.util import logging
|
|
|
|
from openstack_governance import members
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class MembersTable(tables.Table):
|
|
"""Insert the members table using the referenced file as source.
|
|
"""
|
|
|
|
HEADERS = ('Full Name', 'IRC', 'E-mail', 'Term Expires', 'Role')
|
|
HEADER_MAP = {
|
|
'Full Name': 'name',
|
|
'IRC': 'irc',
|
|
'E-mail': 'email',
|
|
'Term Expires': 'date',
|
|
'Role': 'role',
|
|
}
|
|
|
|
option_spec = {'class': directives.class_option,
|
|
'name': directives.unchanged,
|
|
'datafile': directives.unchanged,
|
|
}
|
|
|
|
has_content = False
|
|
|
|
def run(self):
|
|
env = self.state.document.settings.env
|
|
|
|
# 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 membertable directive',
|
|
nodes.literal_block(self.block_text, self.block_text),
|
|
line=self.lineno)
|
|
return [error]
|
|
|
|
# Handle the width settings and title
|
|
try:
|
|
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)
|
|
|
|
# Build the table node using the parsed file
|
|
data_iter = members.parse_members_file(filename)
|
|
table_node = self.build_table(
|
|
data_iter,
|
|
col_widths,
|
|
)
|
|
table_node['classes'] += self.options.get('class', [])
|
|
self.add_name(table_node)
|
|
|
|
if title:
|
|
table_node.insert(0, title)
|
|
|
|
return [table_node] + messages
|
|
|
|
def build_table(self, table_data, col_widths):
|
|
table = nodes.table()
|
|
|
|
# Set up the column specifications
|
|
# based on the widths.
|
|
tgroup = nodes.tgroup(cols=len(col_widths))
|
|
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 = []
|
|
for row in table_data:
|
|
trow = nodes.row()
|
|
# Iterate over the headers in the same order every time.
|
|
for h in self.HEADERS:
|
|
# Get the cell value from the row data, replacing None
|
|
# in re match group with empty string.
|
|
cell = row.get(self.HEADER_MAP[h]) or ''
|
|
entry = nodes.entry()
|
|
para = nodes.paragraph(text=str(cell))
|
|
entry += para
|
|
trow += entry
|
|
rows.append(trow)
|
|
tbody.extend(rows)
|
|
|
|
return table
|
|
|
|
|
|
def setup(app):
|
|
LOG.info('loading members extension')
|
|
app.add_directive('memberstable', MembersTable)
|