| From 217e2bfab22e740227df09f22165e834cddd8a3b Mon Sep 17 00:00:00 2001 |
| From: Dmitry Shachnev <mitya57@debian.org> |
| Date: Sun, 18 Dec 2016 13:11:46 +0300 |
| Subject: docs: sphinx-extensions: make rstFlatTable work with docutils 0.13 |
| |
| From: Dmitry Shachnev <mitya57@debian.org> |
| |
| commit 217e2bfab22e740227df09f22165e834cddd8a3b upstream. |
| |
| In docutils 0.13, the return type of get_column_widths method of the |
| Table directive has changed [1], which breaks our flat-table directive |
| and leads to a TypeError when trying to build the docs [2]. |
| |
| This patch adds support for the new return type, while keeping support |
| for older docutils versions too. |
| |
| [1] https://sourceforge.net/p/docutils/patches/120/ |
| [2] https://sourceforge.net/p/docutils/bugs/303/ |
| |
| Signed-off-by: Dmitry Shachnev <mitya57@debian.org> |
| Signed-off-by: Jonathan Corbet <corbet@lwn.net> |
| Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> |
| |
| --- |
| Documentation/sphinx/rstFlatTable.py | 5 +++++ |
| 1 file changed, 5 insertions(+) |
| |
| --- a/Documentation/sphinx/rstFlatTable.py |
| +++ b/Documentation/sphinx/rstFlatTable.py |
| @@ -151,6 +151,11 @@ class ListTableBuilder(object): |
| def buildTableNode(self): |
| |
| colwidths = self.directive.get_column_widths(self.max_cols) |
| + if isinstance(colwidths, tuple): |
| + # Since docutils 0.13, get_column_widths returns a (widths, |
| + # colwidths) tuple, where widths is a string (i.e. 'auto'). |
| + # See https://sourceforge.net/p/docutils/patches/120/. |
| + colwidths = colwidths[1] |
| stub_columns = self.directive.options.get('stub-columns', 0) |
| header_rows = self.directive.options.get('header-rows', 0) |
| |