mirror of
https://github.com/AdaCore/cvc5.git
synced 2026-02-12 12:32:16 -08:00
b08ef33d5a
This PR moves some stuff around in our documentation. Most notably, it moves some sections out of the "Binary documentation" to become their own top-level sections. While doing so, it refactors a few things in options and statistics to be more agnostic to the way cvc5 is used. To allow for command-output being used in regular (not auto-generated) documentation, we add a new extension that takes care of injecting the build folder into a new wrapper run-command.
58 lines
1.8 KiB
Python
58 lines
1.8 KiB
Python
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,
|
|
}
|