1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
import os
from docutils import nodes
from docutils.parsers.rst import Directive
from docutils.statemachine import StringList
class APIExamples(Directive):
"""Add directive `api-examples` to be used as follows:
.. api-examples::
file1
file2
The arguments should be proper filenames to source files.
This directives tries to detect the language from the file extension
and supports the file extensions specified in `self.exts`.
"""
# Set tab title and language for syntax highlighting
exts = {
'.cpp': {'title': 'C++', 'lang': 'c++'},
'.java': {'title': 'Java', 'lang': 'java'},
'.py': {'title': 'Python', 'lang': 'python'},
'.smt2': {'title': 'SMT-LIBv2', 'lang': 'smtlib'},
}
# The "arguments" are actually the content of the directive
has_content = True
def run(self):
# collect everything in a list of strings
content = ['.. tabs::', '']
for file in self.content:
# detect file extension
_, ext = os.path.splitext(file)
if ext in self.exts:
title = self.exts[ext]['title']
lang = self.exts[ext]['lang']
else:
title = ext
lang = ext
# generate tabs
content.append(f' .. tab:: {title}')
content.append(f'')
content.append(f' .. literalinclude:: {file}')
content.append(f' :language: {lang}')
content.append(f' :linenos:')
# parse the string list
node = nodes.Element()
self.state.nested_parse(StringList(content), 0, node)
return node.children
def setup(app):
app.setup_extension('sphinx_tabs.tabs')
app.add_directive("api-examples", APIExamples)
return {
'version': '0.1',
'parallel_read_safe': True,
'parallel_write_safe': True,
}
|
