# cobbled together from: # https://github.com/sphinx-contrib/documentedlist/blob/master/sphinxcontrib/documentedlist.py # https://github.com/sphinx-doc/sphinx/blob/v1.6.3/sphinx/ext/graphviz.py # https://github.com/thewtex/sphinx-contrib/blob/master/exceltable/sphinxcontrib/exceltable.py # https://bitbucket.org/prometheus/sphinxcontrib-htsql/src/331a542c29a102eec9f8cba44797e53a49de2a49/sphinxcontrib/htsql.py?at=default&fileviewer=file-view-default # into the glory that follows: import json import six import yaml import sphinx import datetime from docutils.parsers.rst import Directive from docutils import nodes from sphinx.util import logging class CephReleases(Directive): has_content = False required_arguments = 1 optional_arguments = 0 option_spec = {} def run(self): filename = self.arguments[0] document = self.state.document env = document.settings.env rel_filename, filename = env.relfn2path(filename) env.note_dependency(filename) try: with open(filename, 'r') as fp: releases = yaml.safe_load(fp) releases = releases["releases"] except Exception as e: return [document.reporter.warning( "Failed to open Ceph releases file {}: {}".format(filename, e), line=self.lineno)] table = nodes.table() tgroup = nodes.tgroup(cols=3) table += tgroup tgroup.extend( nodes.colspec(colwidth=30, colname='c'+str(idx)) for idx, _ in enumerate(range(4))) 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 ["Version", "Initial release", "Latest", "End of life (estimated)"]) releases = six.iteritems(releases) releases = sorted(releases, key=lambda t: t[0], reverse=True) tbody = nodes.tbody() tgroup += tbody rows = [] for code_name, info in releases: actual_eol = info.get("actual_eol", None) if actual_eol and actual_eol <= datetime.datetime.now().date(): continue trow = nodes.row() entry = nodes.entry() para = nodes.paragraph(text="`{}`_".format(code_name)) sphinx.util.nodes.nested_parse_with_titles( self.state, para, entry) #entry += para trow += entry sorted_releases = sorted(info["releases"], key=lambda t: [t["released"]] + list(map(lambda v: int(v), t["version"].split(".")))) oldest_release = sorted_releases[0] newest_release = sorted_releases[-1] entry = nodes.entry() para = nodes.paragraph(text="{}".format( oldest_release["released"].strftime("%b %Y"))) entry += para trow += entry entry = nodes.entry() if newest_release.get("skip_ref", False): para = nodes.paragraph(text="{}".format( newest_release["version"])) else: para = nodes.paragraph(text="`{}`_".format( newest_release["version"])) sphinx.util.nodes.nested_parse_with_titles( self.state, para, entry) #entry += para trow += entry entry = nodes.entry() para = nodes.paragraph(text="{}".format( info.get("target_eol", "--"))) entry += para trow += entry rows.append(trow) tbody.extend(rows) return [table] class CephTimeline(Directive): has_content = False required_arguments = 13 optional_arguments = 0 option_spec = {} def run(self): filename = self.arguments[0] document = self.state.document env = document.settings.env rel_filename, filename = env.relfn2path(filename) env.note_dependency(filename) try: with open(filename, 'r') as fp: releases = yaml.safe_load(fp) except Exception as e: return [document.reporter.warning( "Failed to open Ceph releases file {}: {}".format(filename, e), line=self.lineno)] display_releases = self.arguments[1:] timeline = [] for code_name, info in six.iteritems(releases["releases"]): if code_name in display_releases: for release in info.get("releases", []): released = release["released"] timeline.append((released, code_name, release["version"], release.get("skip_ref", False))) assert "development" not in releases["releases"] if "development" in display_releases: for release in releases["development"]["releases"]: released = release["released"] timeline.append((released, "development", release["version"], release.get("skip_ref", False))) timeline = sorted(timeline, key=lambda t: t[0], reverse=True) table = nodes.table() tgroup = nodes.tgroup(cols=3) table += tgroup columns = ["Date"] + display_releases tgroup.extend( nodes.colspec(colwidth=30, colname='c'+str(idx)) for idx, _ in enumerate(range(len(columns)))) thead = nodes.thead() tgroup += thead row_node = nodes.row() thead += row_node for col in columns: entry = nodes.entry() if col.lower() in ["date", "development"]: para = nodes.paragraph(text=col) else: para = nodes.paragraph(text="`{}`_".format(col)) sphinx.util.nodes.nested_parse_with_titles( self.state, para, entry) row_node += entry tbody = nodes.tbody() tgroup += tbody rows = [] for row_info in timeline: trow = nodes.row() entry = nodes.entry() para = nodes.paragraph(text=row_info[0].strftime("%b %Y")) entry += para trow += entry for release in display_releases: entry = nodes.entry() if row_info[1] == release: if row_info[3]: # if skip ref para = nodes.paragraph(text=row_info[2]) else: para = nodes.paragraph(text="`{}`_".format(row_info[2])) sphinx.util.nodes.nested_parse_with_titles( self.state, para, entry) else: para = nodes.paragraph(text="--") entry += para trow += entry rows.append(trow) tbody.extend(rows) return [table] def setup(app): app.add_directive('ceph_releases', CephReleases) app.add_directive('ceph_timeline', CephTimeline)