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
66
67
68
69
70
71
|
###############################################################################
# Top contributors (to current version):
# Gereon Kremer
#
# This file is part of the cvc5 project.
#
# Copyright (c) 2009-2025 by the authors listed in the file AUTHORS
# in the top-level source directory and their institutional affiliations.
# All rights reserved. See the file COPYING in the top-level source
# directory for licensing information.
# #############################################################################
#
# Sphinx extension, implements directive 'run-command'.
##
from docutils import nodes
from docutils.parsers.rst import directives
from docutils.statemachine import StringList
from sphinx.util.docutils import SphinxDirective
class RunCommand(SphinxDirective):
"""Add directive `run-command` that enhances `command-output` by proper usage
of the build directory. It is used just the same as `command-output`:
.. run-command:: <command>
:cwd: /directory
The only difference to `command-output` is that the current working directory
defaults to the current build folder, and the directory (optionally) given
to the `cwd` option allows for the following placeholders:
- `<build>`: current build folder
The path of the build folder needs to be configured in the `runcmd_build` option.
"""
has_content = True
option_spec = {
'cwd': directives.path
}
def run(self):
self.state.document.settings.env.note_dependency(__file__)
cwd = self.env.config.runcmd_build
if 'cwd' in self.options:
repl = {
'<build>': self.env.config.runcmd_build,
}
cwd = self.options['cwd']
for r,s in repl.items():
cwd = cwd.replace(r, s)
content = [
'.. command-output:: ' + ''.join(self.content),
' :cwd: ' + cwd]
node = nodes.Element()
self.state.nested_parse(StringList(content), 0, node)
return node.children
def setup(app):
app.setup_extension('sphinxcontrib.programoutput')
app.add_config_value('runcmd_build', '', 'env')
app.add_directive("run-command", RunCommand)
return {
'version': '0.1',
'parallel_read_safe': True,
'parallel_write_safe': True,
}
|
