aboutsummaryrefslogtreecommitdiffstats
path: root/doc/exec.py
diff options
context:
space:
mode:
Diffstat (limited to 'doc/exec.py')
-rw-r--r--doc/exec.py36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/exec.py b/doc/exec.py
new file mode 100644
index 000000000..f6ad8a8e8
--- /dev/null
+++ b/doc/exec.py
@@ -0,0 +1,36 @@
+# https://stackoverflow.com/questions/7250659/how-to-use-python-to-programmatically-generate-part-of-sphinx-documentation/18143318
+
+import sys
+from os.path import basename
+
+try:
+ from StringIO import StringIO
+except ImportError:
+ from io import StringIO
+
+from docutils.parsers.rst import Directive
+from docutils import nodes, statemachine
+
+class ExecDirective(Directive):
+ """Execute the specified python code and insert the output into the document"""
+ has_content = True
+
+ def run(self):
+ oldStdout, sys.stdout = sys.stdout, StringIO()
+
+ tab_width = self.options.get('tab-width', self.state.document.settings.tab_width)
+ source = self.state_machine.input_lines.source(self.lineno - self.state_machine.input_offset - 1)
+
+ try:
+ exec('\n'.join(self.content))
+ text = sys.stdout.getvalue()
+ lines = statemachine.string2lines(text, tab_width, convert_whitespace=True)
+ self.state_machine.insert_input(lines, source)
+ return []
+ except Exception:
+ return [nodes.error(None, nodes.paragraph(text = "Unable to execute python code at %s:%d:" % (basename(source), self.lineno)), nodes.paragraph(text = str(sys.exc_info()[1])))]
+ finally:
+ sys.stdout = oldStdout
+
+def setup(app):
+ app.add_directive('exec', ExecDirective)