You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -186,7 +186,7 @@ The configuration options available are:
186
186
-`!^_`: filter out every object whose name starts with `_` (private/protected)
187
187
-`^__`: but still select those who start with two `_` (class-private)
188
188
-`!^__.*__$`: except those who also end with two `_` (specials)
189
-
189
+
190
190
-`members`: this option allows to explicitly select the members of the top-object.
191
191
If `True`, select every members that passes filters. If `False`, select nothing.
192
192
If it's a list of names, select only those members, and apply filters on their children only.
@@ -196,13 +196,16 @@ The configuration options available are:
196
196
-`docstring_style`: the docstring style to use when parsing the docstring. `google`, `restructured-text`<sup>1</sup> and `numpy`<sup>2</sup>.
197
197
198
198
-`docstring_options`: options to pass to the docstring parser.
199
-
-`google` accepts a `replace_admonitions` boolean option (default: true). When enabled, this option will
199
+
-`replace_admonitions` boolean option (default: true). When enabled, this option will
200
200
replace titles of an indented block by their Markdown admonition equivalent:
201
201
`AdmonitionType: Title` will become `!!! admonitiontype "Title"`.
202
-
-`restructured-text` does not accept any options.
203
-
-`numpy` does not accept any options.
202
+
-`trim_doctest_flags` boolean option (default: true). When enabled, all doctest
203
+
flags (of the form `# doctest: +FLAG` and `<BLANKLINE>`) located within python
204
+
example blocks will be removed from the parsed output.
205
+
206
+
The `google` docstring style accepts both options. The `numpy` style only accepts `trim_doctest_flags`. The `restructured-text` style does not accept any options.
204
207
205
-
<sup>1</sup>: reStructured Text parsing is in active development and is not feature complete yet.
208
+
<sup>1</sup>: reStructured Text parsing is in active development and is not feature complete yet.</br>
206
209
<sup>2</sup>: The following sections are currently not supported : `Notes`, `See Also`, `Warns` and `References`.
0 commit comments