Cargo-culting doc building from openstack/ossa

* Directories tree for mitaka projects
* Tools to check candidacy
* Generate candidates lists

Change-Id: I784bc4a3a06d3d7506df6d2ef7e6b0362f7696b9

.gitignore

@@ -0,0 +1,13 @@
+.*sw?
+*~
+.tox
+doc/build
+*.egg-info
+pbr*.egg
+reference/projects/*.rst
+*.pyc
+AUTHORS
+ChangeLog
+candidates/ptl.rst
+candidates/tc.rst
+.projects.yaml

README.rst

@@ -0,0 +1,13 @@
+This repository contains OpenStack Elections reference documents
+and track candidate lists and elections' results.
+
+Directory structure:
+
+    candidates/
+        <OpenStack codename>/   e.g mitaka (case matters)
+            <Project>/          e.g Nova (case matters)
+                <Candidate_Name>.txt
+            TC/
+                <Candidate_Name>.txt
+    results/
+        Only edititable by the Election officials

doc/source/_exts/candidates.py

@@ -0,0 +1,78 @@
+#    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 candidates list
+"""
+
+import os
+
+from jinja2 import FileSystemLoader
+from jinja2.environment import Environment
+
+BASE_URL = "http://git.openstack.org/cgit/openstack/election"
+PATH_PREFIX = 'candidates'
+
+
+def render_template(template, data, **kwargs):
+    template_dir = kwargs.get('template_dir', os.getcwd())
+    loader = FileSystemLoader(template_dir)
+    env = Environment(trim_blocks=True, loader=loader)
+    template = env.get_template(template)
+    return template.render(data)
+
+
+def build_candidates_list(election):
+    project_list = os.listdir(os.path.join(PATH_PREFIX, election))
+    project_list.sort()
+
+    candidates_lists = {}
+    for project in project_list:
+        project_prefix = os.path.join(PATH_PREFIX, election, project)
+        candidates_list = filter(
+            lambda x: x.endswith(".txt"),
+            os.listdir(unicode(project_prefix)),
+        )
+        candidates_list = [os.path.join(project_prefix, c)
+                           for c in candidates_list]
+        candidates_list.sort()
+        candidates_lists[project] = candidates_list
+
+    return {'election': election,
+            'projects': project_list,
+            'candidates': candidates_lists}
+
+
+def render_list(list_type, candidates_list):
+    output_file = os.path.join(PATH_PREFIX, "%s.rst" % list_type)
+    template_name = "%s.jinja" % list_type
+    template_dir = os.path.join(".", "doc", "source", "_exts")
+    with open(output_file, "w") as out:
+        out.write(
+            render_template(
+                template_name,
+                candidates_list,
+                template_dir=template_dir
+            ).encode('utf-8')
+        )
+
+
+def build_lists(app):
+    # TODO: make mitaka a parameter
+    election = 'mitaka'
+    candidates_list = build_candidates_list(election)
+    render_list("ptl", candidates_list)
+    render_list("tc", candidates_list)
+
+
+def setup(app):
+    app.info('loading candidates extension')
+    app.connect('builder-inited', build_lists)

doc/source/_exts/ptl.jinja

@@ -0,0 +1,10 @@
+{{ election.capitalize() }} PTL Candidates
+======================
+{% for project in projects %}{% if project != 'TC' %}
+* `{{ project }} <http://git.openstack.org/cgit/openstack/election/plain/candidates/{{ election }}/{{ project }}>`_
+
+{% for candidate in candidates[project] %}
+  * `{{ candidate.split('/')[-1][:-4] }} <http://git.openstack.org/cgit/openstack/election/plain/{{ candidate }}>`_
+{% endfor %}
+
+{% endif %}{% endfor %}

doc/source/_exts/tc.jinja

@@ -0,0 +1,6 @@
+{{ election.capitalize() }} TC Candidates
+======================
+
+{% for candidate in candidates['TC'] %}
+  * `{{ candidate.split('/')[-1][:-4] }} <http://git.openstack.org/cgit/openstack/election/plain/{{ candidate }}>`_
+{% endfor %}

doc/source/candidates

@@ -0,0 +1 @@
+../../candidates/

doc/source/conf.py

@@ -0,0 +1,287 @@
+# -*- 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',
+    'candidates',
+]
+
+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 Election'
+copyright = u'2015, OpenStack'
+
+# 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', 'candidates/ptl.rst', 'candidates/tc.rst']
+
+# 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
+# "<project> v<release> 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 <link> 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 TC', '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 TC', '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 Election'
+epub_author = u'OpenStack Election Officials'
+epub_publisher = u'OpenStack'
+epub_copyright = u'2015, OpenStack'
+
+# 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

doc/source/index.rst

@@ -0,0 +1,21 @@
+====================
+ OpenStack Election
+====================
+
+This page track OpenStack Elections candidates list.
+
+.. include:: ./candidates/ptl.rst
+
+
+Election Officials
+==================
+
+* Tony Breeds (tonyb)
+* Tristan Cacqueray (tristanC)
+
+.. seealso::
+
+  See the Election_Officiating_Guidelines_ page in the wiki for details on the
+  election process.
+
+.. _Election_Officiating_Guidelines: https://wiki.openstack.org/wiki/Election_Officiating_Guidelines

setup.cfg

@@ -0,0 +1,16 @@
+[metadata]
+name = openstack-election
+version = 11.0
+summary = OpenStack Election Documents
+description-file = README.rst
+author = OpenStack Election Officials
+author-email = openstack-dev@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

setup.py

@@ -0,0 +1,29 @@
+# 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
+
+# In python < 2.7.4, a lazy loading of package `pbr` will break
+# setuptools if some other modules registered functions in `atexit`.
+# solution from: http://bugs.python.org/issue15881#msg170215
+try:
+    import multiprocessing  # noqa
+except ImportError:
+    pass
+
+setuptools.setup(
+    setup_requires=['pbr>=1.3'],
+    pbr=True)

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
+sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
+oslosphinx>=2.5.0 # Apache-2.0
+PyYAML>=3.1.0,<=3.10

tools/check-candidacy.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+
+import yaml
+import os
+import sys
+import urllib
+import re
+import datetime
+
+DATE_MIN = '2014-09-18'
+DATE_MAX = '2015-09-18'
+
+BASE_URL = 'https://git.openstack.org/cgit'
+PROJECTS_URL = ('%s/openstack/governance/plain/reference/projects.yaml' %
+                (BASE_URL))
+
+date_min = datetime.datetime.strptime(DATE_MIN, '%Y-%m-%d').strftime('%s')
+date_max = datetime.datetime.strptime(DATE_MAX, '%Y-%m-%d').strftime('%s')
+
+
+def check_date(date):
+    epoch = datetime.datetime.strptime(date, '%Y-%m-%d').strftime('%s')
+    if epoch > date_min and epoch < date_max:
+        return True
+    return False
+
+try:
+    project_name = os.path.basename(os.path.dirname(sys.argv[1]))
+    author = os.path.basename(sys.argv[1])[:-4].replace(' ', '+')
+except:
+    print "usage: %s candidacy_file" % sys.argv[0]
+    exit(1)
+
+if not os.path.isfile('.projects.yaml'):
+    open('.projects.yaml', 'w').write(
+        urllib.urlopen(PROJECTS_URL).read()
+    )
+projects = yaml.load(open('.projects.yaml'))
+
+if project_name == "TC":
+    project_list = projects.values()
+else:
+    try:
+        project_list = [projects[project_name]]
+    except:
+        print "Can't find project [%s] in %s" % (project_name, projects.keys())
+        exit(1)
+
+for project in project_list:
+    for deliverable in project['deliverables'].values():
+        for repo_name in deliverable["repos"]:
+            url = '%s/%s/log/?qt=author&q=%s' % (BASE_URL, repo_name, author)
+            print "Querying: %s" % url
+            found = False
+            for l in urllib.urlopen(url).read().split('\n'):
+                if "commit/?id=" not in l:
+                    continue
+                try:
+                    url = ('http://git.openstack.org/%s' %
+                           re.search("href='([^']*)'", l).groups()[0])
+                    date = re.search('<td>([^<]*)</td>', l).groups()[0]
+                    if not check_date(date):
+                        continue
+                except:
+                    continue
+                print "[%s]: %s" % (date, url)
+                found = True
+            if found:
+                exit(0)
+exit(1)

tools/render-wiki-list.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+
+import sys
+sys.path.append("doc/source/_exts")
+from candidates import build_candidates_list
+
+GIT_BASE = 'http://git.openstack.org/cgit/openstack/election/plain/'
+
+
+def main(argv):
+    if len(argv) != 2 or argv[1] not in ("PTL", "TC"):
+        print "usage: %s PTL|TC" % argv[0]
+        return
+    candidates_list = build_candidates_list("mitaka")
+
+    if argv[1] == "PTL":
+        candidates_list['projects'].remove('TC')
+    else:
+        candidates_list['projects'] = ['TC']
+
+    for project in candidates_list['projects']:
+        print "* %s" % project
+        for candidate in candidates_list['candidates'][project]:
+            print "** [%s/%s %s]" % (GIT_BASE,
+                                     candidate.replace(' ', '%20'),
+                                     candidate.split('/')[-1][:-4])
+
+if __name__ == "__main__":
+    main(sys.argv)

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