Skip to contentSkip to conversation

Patch "docs: sphinx-extensions: make rstFlatTable work with docutils 0.13" has been added to the 4.9-stable tree

PATCH [email protected] 1 participant 1 message Jan 6, 2017

Subsystems (3)
lore
Share & tools
lore

[email protected]

author maintainer Applied
#0 lore raw

This is a note to let you know that I've just added the patch titled

docs: sphinx-extensions: make rstFlatTable work with docutils 0.13

to the 4.9-stable tree which can be found at:
http://www.kernel.org/git/?p=linux/kernel/git/stable/stable-queue.git;a=summary

The filename of the patch is:
docs-sphinx-extensions-make-rstflattable-work-with-docutils-0.13.patch
and it can be found in the queue-4.9 subdirectory.

If you, or anyone else, feels it should not be added to the stable tree, please let <[email protected]> know about it.

Quoted 1 line

From 217e2bfab22e740227df09f22165e834cddd8a3b Mon Sep 17 00:00:00 2001

From: Dmitry Shachnev <[email protected]>
Date: Sun, 18 Dec 2016 13:11:46 +0300
Subject: docs: sphinx-extensions: make rstFlatTable work with docutils 0.13

From: Dmitry Shachnev <[email protected]>

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/

---
 Documentation/sphinx/rstFlatTable.py |    5 +++++
 1 file changed, 5 insertions(+)
Documentation/sphinx/rstFlatTable.py +5 -0
@@ -157,6 +157,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)
 

Patches currently in stable-queue which might be from [email protected] are

queue-4.9/docs-sphinx-extensions-make-rstflattable-work-with-docutils-0.13.patch