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
|
#! /usr/bin/env python3
# Requires Python 3.6+
"""Sphinx extension for generating the rules table document."""
from typing import Dict, List, Union
from sphinx.application import Sphinx
from sphinx.util.docutils import SphinxDirective
from sphinx.util.nodes import nested_parse_with_titles, nodes
# isort: split
from docutils import statemachine
from ansiblelint import __version__
from ansiblelint.constants import DEFAULT_RULESDIR
from ansiblelint.generate_docs import rules_as_rst
from ansiblelint.rules import RulesCollection
def _nodes_from_rst(
state: statemachine.State,
rst_source: str,
) -> List[nodes.Node]:
"""Turn an RST string into a list of nodes.
These nodes can be used in the document.
"""
node = nodes.Element()
node.document = state.document
nested_parse_with_titles(
state=state,
content=statemachine.ViewList(
statemachine.string2lines(rst_source),
source='[ansible-lint autogenerated]',
),
node=node,
)
return node.children
class AnsibleLintDefaultRulesDirective(SphinxDirective):
"""Directive ``ansible-lint-default-rules-list`` definition."""
has_content = False
def run(self) -> List[nodes.Node]:
"""Generate a node tree in place of the directive."""
self.env.note_reread() # rebuild the current RST doc unconditionally
default_rules = RulesCollection([DEFAULT_RULESDIR])
rst_rules_table = rules_as_rst(default_rules)
return _nodes_from_rst(state=self.state, rst_source=rst_rules_table)
def setup(app: Sphinx) -> Dict[str, Union[bool, str]]:
"""Initialize the Sphinx extension."""
app.add_directive(
'ansible-lint-default-rules-list',
AnsibleLintDefaultRulesDirective,
)
return {
'parallel_read_safe': True,
'parallel_write_safe': True,
'version': __version__,
}
|
