Render member list in HTML output

Add a memberstable directive that knows how to parse
the membership roster and add it to the sphinx document
tree to be rendered.

Change-Id: I099c7c061d6f51c8a2678d35aeddde4f436df25c
Doug Hellmann 2014-04-30 16:09:48 -04:00
parent 37178d955d
commit 5041382a0b
4 changed files with 156 additions and 2 deletions

doc/source/_exts/ Normal file
View File

@ -0,0 +1,139 @@
"""Build a table of the current members of the TC.
import re
from docutils import nodes
from docutils.parsers.rst.directives.tables import Table
from docutils.parsers.rst import directives
# Full name (IRC nickname) [expires in] {role}
_PATTERN = re.compile('(?P<name>.*)\s+\((?P<irc>.*)\)\s+\[(?P<date>.*)\](\s+\{(?P<role>.*)\})?')
def _parse_members_file(app, filename):
"""Load the members file and return each row as a dictionary.
with open(filename, 'r') as f:
for linum, line in enumerate(f, 1):
line = line.strip()
if not line or line.startswith('#'):
m = _PATTERN.match(line)
if not m:
app.warning('Could not parse line %d of %s: %r' %
(linum, filename, line))
yield m.groupdict()
class MembersTable(Table):
"""Insert the members table using the referenced file as source.
HEADERS = ('Full Name', 'IRC Nickname', 'Term Expires', 'Role')
'Full Name': 'name',
'IRC Nickname': 'irc',
'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
app =
config = app.config
# 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),
return [error]
# Handle the width settings and title
col_widths = self.get_column_widths(len(self.HEADERS))
title, messages = self.make_title()
except SystemMessagePropagation, detail:
return [detail.args[0]]
except Exception, err:
error = self.state_machine.reporter.error(
'Error processing memberstable directive:\n%s' % err,
nodes.literal_block(self.block_text, self.block_text),
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 = _parse_members_file(app, filename)
table_node = self.build_table(
table_node['classes'] += self.options.get('class', [])
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
for col_width in col_widths)
# Set the headers
thead = nodes.thead()
tgroup += thead
row_node = nodes.row()
thead += row_node
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=unicode(cell))
entry += para
trow += entry
return table
def setup(app):'loading members extension')
app.add_directive('memberstable', MembersTable)

View File

@ -17,7 +17,7 @@ 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.abspath('.'))
sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts'))
# -- General configuration -----------------------------------------------------
@ -26,7 +26,10 @@ import os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['oslosphinx']
extensions = [
todo_include_todos = True

View File

@ -8,6 +8,7 @@ Reference documents which need to be revised over time.
:maxdepth: 2

reference/membership.rst Normal file
View File

@ -0,0 +1,11 @@
Current Membership
.. See _exts/
:Last election: April 2014
.. memberstable:: TC Member Contact and Term Details
:datafile: members