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
|
###############################################################################
# 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 'include-build-file'.
##
import os
from docutils import nodes
from docutils.parsers.rst import Directive
from docutils.statemachine import StringList
from sphinx.util.docutils import SphinxDirective
from sphinx.util.nodes import nested_parse_with_titles
class IncludeBuildFile(SphinxDirective):
"""Add directive `include-build-file` to be used as follows:
.. include-build-file:: <filename>
The argument should be a filename of an rst files within one of the
folders given by the `ibf_folders` config option.
"""
# The "arguments" are actually the content of the directive
has_content = True
def run(self):
self.state.document.settings.env.note_dependency(__file__)
filename = ''.join(self.content)
for folder in self.env.config.ibf_folders:
candidate = os.path.join(folder, filename)
if os.path.isfile(candidate):
filename = candidate
break
content = open(filename).readlines()
content = [line.rstrip('\n') for line in content]
# parse the string list
node = nodes.Element()
nested_parse_with_titles(self.state, StringList(content), node)
self.state.document.settings.env.note_dependency(filename)
return node.children
def setup(app):
app.add_config_value('ibf_folders', [], 'env')
app.add_directive('include-build-file', IncludeBuildFile)
return {
'version': '0.1',
'parallel_read_safe': True,
'parallel_write_safe': True,
}
|
