@@ -18,7 +18,11 @@ def setup(app):
18
18
"""
19
19
Install the plugin.
20
20
21
- :argument sphinx.application.Sphinx app: the Sphinx application context
21
+ Arguments:
22
+
23
+ app (sphinx.application.Sphinx):
24
+
25
+ the Sphinx application context
22
26
23
27
"""
24
28
@@ -39,7 +43,11 @@ def fetch_or_load(spec_path):
39
43
"""
40
44
Fetch a new specification or use the cache if it's current.
41
45
42
- :argument cache_path: the path to a cached specification
46
+ Arguments:
47
+
48
+ cache_path:
49
+
50
+ the path to a cached specification
43
51
44
52
"""
45
53
@@ -83,14 +91,34 @@ def validator(name, raw_text, text, lineno, inliner):
83
91
"""
84
92
Link to the JSON Schema documentation for a validator.
85
93
86
- :argument str name: the name of the role in the document
87
- :argument str raw_source: the raw text (role with argument)
88
- :argument str text: the argument given to the role
89
- :argument int lineno: the line number
90
- :argument docutils.parsers.rst.states.Inliner inliner: the inliner
94
+ Arguments:
95
+
96
+ name (str):
97
+
98
+ the name of the role in the document
99
+
100
+ raw_source (str):
101
+
102
+ the raw text (role with argument)
103
+
104
+ text (str):
105
+
106
+ the argument given to the role
107
+
108
+ lineno (int):
109
+
110
+ the line number
111
+
112
+ inliner (docutils.parsers.rst.states.Inliner):
113
+
114
+ the inliner
115
+
116
+ Returns:
117
+
118
+ tuple:
91
119
92
- :returns: 2-tuple of nodes to insert into the document and an iterable
93
- of system messages, both possibly empty
120
+ a 2-tuple of nodes to insert into the document and an
121
+ iterable of system messages, both possibly empty
94
122
95
123
"""
96
124
0 commit comments