148 lines
4.4 KiB
Python
148 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.
|
|
|
|
"""Report on the current list of projects.
|
|
"""
|
|
|
|
from docutils import nodes
|
|
from docutils.parsers import rst
|
|
from docutils import statemachine
|
|
from sphinx.util import logging
|
|
from sphinx.util.nodes import nested_parse_with_titles
|
|
|
|
import projects
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
IRC_LOG_URL_BASE = 'http://eavesdrop.openstack.org/irclogs/%23'
|
|
|
|
|
|
def _team_to_rst(name, info):
|
|
|
|
if 'service' in info:
|
|
title = "{0} ({1})".format(name.title(), info['service'])
|
|
elif name == 'I18n':
|
|
title = name
|
|
else:
|
|
title = name.title()
|
|
|
|
yield '.. _project-%s:' % projects.slugify(name)
|
|
yield ''
|
|
yield '=' * len(title)
|
|
yield title
|
|
yield '=' * len(title)
|
|
yield ''
|
|
yield ':Home Page: ' + info.get('url', '')
|
|
ptl = info.get('ptl', {'name': '', 'irc': '', 'email': ''})
|
|
yield ':PTL: %(name)s (``%(irc)s``) <%(email)s>' % ptl
|
|
irc_channel = info.get('irc-channel')
|
|
if irc_channel:
|
|
yield ':IRC Channel: `#%s <%s%s>`__' % (
|
|
irc_channel, IRC_LOG_URL_BASE, irc_channel)
|
|
service = info.get('service')
|
|
if service:
|
|
yield ':Service: ' + service
|
|
yield ''
|
|
mission = info.get('mission', '').rstrip()
|
|
if mission:
|
|
yield "Mission"
|
|
yield '-------'
|
|
yield ''
|
|
yield mission
|
|
yield ''
|
|
tags = info.get('tags', [])
|
|
if tags:
|
|
yield 'Team-based tags'
|
|
yield '---------------'
|
|
yield ''
|
|
for tag in tags:
|
|
yield '- :ref:`tag-%s`' % tag
|
|
yield ''
|
|
yield 'Deliverables'
|
|
yield '------------'
|
|
yield ''
|
|
deliverables = info.get('deliverables', [])
|
|
if deliverables:
|
|
for repo_name, deliverable in deliverables.items():
|
|
yield repo_name
|
|
yield '~' * len(repo_name)
|
|
yield ''
|
|
yield ':Repositories: ' + ', '.join(
|
|
':repo:`%s`' % repo
|
|
for repo in deliverable.get('repos', [])
|
|
)
|
|
yield ''
|
|
tags = deliverable.get('tags', [])
|
|
if tags:
|
|
yield ':Tags:'
|
|
yield ''
|
|
for tag in tags:
|
|
yield ' - :ref:`tag-%s`' % tag
|
|
yield ''
|
|
else:
|
|
yield 'None'
|
|
yield ''
|
|
if info.get('extra-atcs', []):
|
|
yield 'Extra ATCs'
|
|
yield '-----------'
|
|
yield '.. extraatcstable::'
|
|
yield ' :project: %s' % name
|
|
yield ''
|
|
yield 'Activity metrics'
|
|
yield '----------------'
|
|
yield ''
|
|
url = 'https://www.stackalytics.com/' \
|
|
'?release=all&module=%s-group&metric=commits' % name
|
|
yield 'See `team activity metrics <%s>`_ at Stackalytics.' % url
|
|
yield ''
|
|
|
|
|
|
def _write_team_pages():
|
|
all_teams = projects.get_project_data()
|
|
files = []
|
|
for team, info in all_teams.items():
|
|
slug = projects.slugify(team)
|
|
filename = 'reference/projects/%s.rst' % slug
|
|
LOG.info('generating team page for %s' % team)
|
|
with open(filename, 'w', encoding='utf-8') as f:
|
|
f.write('\n'.join(_team_to_rst(team, info)))
|
|
files.append(filename)
|
|
return files
|
|
|
|
|
|
class TeamsListDirective(rst.Directive):
|
|
|
|
has_content = False
|
|
|
|
def run(self):
|
|
all_teams = projects.get_project_data()
|
|
|
|
# Build the view of the data to be parsed for rendering.
|
|
result = statemachine.ViewList()
|
|
for team_name in sorted(all_teams.keys()):
|
|
team_info = all_teams[team_name]
|
|
for line in _team_to_rst(team_name, team_info):
|
|
result.append(line, '<' + __name__ + '>')
|
|
|
|
# Parse what we have into a new section.
|
|
node = nodes.section()
|
|
node.document = self.state.document
|
|
nested_parse_with_titles(self.state, result, node)
|
|
|
|
return node.children
|
|
|
|
|
|
def setup(app):
|
|
LOG.info('loading teams extension')
|
|
app.add_directive('teamslist', TeamsListDirective)
|
|
_write_team_pages()
|